Enhance builder-likeness of commit::topo::Builder in gix-traverse
#1716
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Currently, `Builder::from_iters` takes as arguments both the tips and ends, and it's the only possibility for specifying either of them during the building process. Considering that `ends` in `Builder::from_iters` is an `Option`, this is not very builder-like and obstructs some use-cases. This change introduces a fn which allows adding additional ends after initial construction of a "fresh" `Builder`.
Currently, `Builder::from_iters` takes as arguments both the tips and ends. Previously, this would be the only possibility for specifying either of them during the building process. To enhance the builder-likeness of `Builder`, we recently introduced a fn for adding additional ends. This change introduces a fn which allows adding additional tips after initial construction of a "fresh" `Builder`, allowing for more usage patterns.
Previously, the only way to create a `Builder` would be via `Builder::from_iters`. That fn takes as arguments both the tips and ends, and used to be the only possibility for specifying either of them during the building process. However, in order to enhance the builder- likeness of `Builder`, we recently introduced fns `with_tips` and `with_ends` for adding additional tips and ends. With those fns, the only component which needs to be supplied up-front is `find`. Users can specify and empty `Iterator` and `None` for `tips` and `ends` respectively when calling `Builder::from_iters` and add additional tips and ends at their leisure, without the need to chain `Iterator`s or collecting them in some external data structure. Now, calling `Builder::from_iters` with a empty lists for tips and ends is a bit awkward. Thus, we provide a new method for creating a bare `Builder`.
neithernut
force-pushed
the
traverse-topo-builder-enhancements
branch
from
3852de6 to
67d876c
Compare
Previously, the only way to create a `Builder` would be via `Builder::from_iters`. That fn takes as arguments both the tips and ends, and used to be the only possibility for specifying either of them during the building process. However, in order to enhance the builder- likeness of `Builder`, we recently introduced various fns allowing for alternative build flows. This fn reduces code duplication by using those new fns for implementing `from_iters`.
neithernut
force-pushed
the
traverse-topo-builder-enhancements
branch
from
67d876c to
29e3bbf
Compare
Byron
approved these changes
Dec 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, the only way to create a
Builderwould be viaBuilder::from_iters. That function takes as arguments both the tips and ends, and used to be the only possibility for specifying either of them during the building process.I would argue that the whole point of a builder is the ability to start with a minimal, setup and configure the resulting entity bit by bit. This would imo include the optional ends of a
Topo, and I would also argue that there are valid use-cases in which a user would also like to add multiple distinct sets of tips without the need forIteratorchaining or, in the worst case, collecting them in another data structure first.These changes introduce a set of functions enabling alternative usage patterns.