Struct git_repository::revision::walk::Platform

pub struct Platform<'repo> { /* private fields */ }

A platform to traverse the revision graph by adding starting points as well as points which shouldn’t be crossed, returned by Repository::rev_walk().

Implementations

impl<'repo> Platform<'repo>

Create-time builder methods

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

Set the sort mode for commits to the given value. The default is to order by topology.

pub fn first_parent_only(self) -> Self

Only traverse the first parent of the commit graph.

impl<'repo> Platform<'repo>

Produce the iterator

pub fn all(self) -> Result<Walk<'repo>, Error>

Return an iterator to traverse all commits reachable as configured by the Platform.

Performance

It’s highly recommended to set an object cache on the parent repo to greatly speed up performance if the returned id is supposed to be looked up right after.