Struct Builder

pub struct Builder<Find, Predicate> { /* private fields */ }

Builder for Topo.

Implementations

impl<Find> Builder<Find, fn(_: &oid) -> bool>

where Find: Find,

pub fn from_iters( find: Find, tips: impl IntoIterator<Item = impl Into<ObjectId>>, ends: Option<impl IntoIterator<Item = impl Into<ObjectId>>>, ) -> Self

Create a new Builder for a Topo that reads commits from a repository with find. starting at the tips and ending at the ends. Like git rev-list --topo-order ^ends tips.

pub fn new(find: Find) -> Self

Create a new Builder for a Topo that reads commits from a repository with find.

pub fn with_predicate<Predicate>( self, predicate: Predicate, ) -> Builder<Find, Predicate>

where Predicate: FnMut(&oid) -> bool,

Set a predicate to filter out revisions from the walk. Can be used to implement e.g. filtering on paths or time. This does not exclude the parent(s) of a revision that is excluded. Specify a revision as an ‘end’ if you want that behavior.

impl<Find, Predicate> Builder<Find, Predicate>

where Find: Find, Predicate: FnMut(&oid) -> bool,

pub fn with_tips( self, tips: impl IntoIterator<Item = impl Into<ObjectId>>, ) -> Self

Add commits to start reading from.

The behavior is similar to specifying additional ends in git rev-list --topo-order ^ends tips.

pub fn with_ends( self, ends: impl IntoIterator<Item = impl Into<ObjectId>>, ) -> Self

Add commits ending the traversal.

These commits themselves will not be read, i.e. the behavior is similar to specifying additional ends in git rev-list --topo-order ^ends tips.

pub fn sorting(self, sorting: Sorting) -> Self

Set the sorting to use for the topological walk.

pub fn parents(self, parents: Parents) -> Self

Specify how to handle commit parents during traversal.

pub fn with_commit_graph(self, commit_graph: Option<Graph>) -> Self

Set or unset the commit_graph to use for the iteration.

pub fn build(self) -> Result<Topo<Find, Predicate>, Error>

Build a new Topo instance.

Note that merely building an instance is currently expensive.