Struct git2::Revwalk

pub struct Revwalk<'repo> {
    // some fields omitted
}

A revwalk allows traversal of the commit graph defined by including one or more leaves and excluding one or more roots.

Methods

impl<'repo> Revwalk<'repo>

fn reset(&mut self)

Reset a revwalk to allow re-configuring it.

The revwalk is automatically reset when iteration of its commits completes.

fn set_sorting(&mut self, sort_mode: Sort)

Set the order in which commits are visited.

fn simplify_first_parent(&mut self)

Simplify the history by first-parent

No parents other than the first for each commit will be enqueued.

fn push(&mut self, oid: Oid) -> Result<(), Error>

Mark a commit to start traversal from.

The given OID must belong to a committish on the walked repository.

The given commit will be used as one of the roots when starting the revision walk. At least one commit must be pushed onto the walker before a walk can be started.

fn push_head(&mut self) -> Result<(), Error>

Push the repository's HEAD

For more information, see push.

fn push_glob(&mut self, glob: &str) -> Result<(), Error>

Push matching references

The OIDs pointed to by the references that match the given glob pattern will be pushed to the revision walker.

A leading 'refs/' is implied if not present as well as a trailing / \ * if the glob lacks '?', ' \ *' or '['.

Any references matching this glob which do not point to a committish will be ignored.

fn push_range(&mut self, range: &str) -> Result<(), Error>

Push and hide the respective endpoints of the given range.

The range should be of the form <commit>..<commit> where each <commit> is in the form accepted by revparse_single. The left-hand commit will be hidden and the right-hand commit pushed.

fn push_ref(&mut self, reference: &str) -> Result<(), Error>

Push the OID pointed to by a reference

The reference must point to a committish.

fn hide(&mut self, oid: Oid) -> Result<(), Error>

Mark a commit as not of interest to this revwalk.

fn hide_head(&mut self) -> Result<(), Error>

Hide the repository's HEAD

For more information, see hide.

fn hide_glob(&mut self, glob: &str) -> Result<(), Error>

Hide matching references.

The OIDs pointed to by the references that match the given glob pattern and their ancestors will be hidden from the output on the revision walk.

A leading 'refs/' is implied if not present as well as a trailing / \ * if the glob lacks '?', ' \ *' or '['.

Any references matching this glob which do not point to a committish will be ignored.

fn hide_ref(&mut self, reference: &str) -> Result<(), Error>

Hide the OID pointed to by a reference.

The reference must point to a committish.

Trait Implementations

impl<'repo> Drop for Revwalk<'repo>

fn drop(&mut self)

impl<'repo> Iterator for Revwalk<'repo>

type Item = Oid

fn next(&mut self) -> Option<Oid>

fn size_hint(&self) -> (usize, Option<usize>)

fn count(self) -> usize

fn last(self) -> Option<Self::Item>

fn nth(&mut self, n: usize) -> Option<Self::Item>

fn chain<U>(self, other: U) -> Chain<Self, U::IntoIter> where U: IntoIterator<Item=Self::Item>

fn zip<U>(self, other: U) -> Zip<Self, U::IntoIter> where U: IntoIterator

fn map<B, F>(self, f: F) -> Map<Self, F> where F: FnMut(Self::Item) -> B

fn filter<P>(self, predicate: P) -> Filter<Self, P> where P: FnMut(&Self::Item) -> bool

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> where F: FnMut(Self::Item) -> Option<B>

fn enumerate(self) -> Enumerate<Self>

fn peekable(self) -> Peekable<Self>

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> where P: FnMut(&Self::Item) -> bool

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> where P: FnMut(&Self::Item) -> bool

fn skip(self, n: usize) -> Skip<Self>

fn take(self, n: usize) -> Take<Self>

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> where F: FnMut(&mut St, Self::Item) -> Option<B>

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> where U: IntoIterator, F: FnMut(Self::Item) -> U

fn fuse(self) -> Fuse<Self>

fn inspect<F>(self, f: F) -> Inspect<Self, F> where F: FnMut(&Self::Item) -> ()

fn by_ref(&mut self) -> &mut Self

fn collect<B>(self) -> B where B: FromIterator<Self::Item>

fn partition<B, F>(self, f: F) -> (B, B) where F: FnMut(&Self::Item) -> bool, B: Default + Extend<Self::Item>

fn fold<B, F>(self, init: B, f: F) -> B where F: FnMut(B, Self::Item) -> B

fn all<F>(&mut self, f: F) -> bool where F: FnMut(Self::Item) -> bool

fn any<F>(&mut self, f: F) -> bool where F: FnMut(Self::Item) -> bool

fn find<P>(&mut self, predicate: P) -> Option<Self::Item> where P: FnMut(&Self::Item) -> bool

fn position<P>(&mut self, predicate: P) -> Option<usize> where P: FnMut(Self::Item) -> bool

fn rposition<P>(&mut self, predicate: P) -> Option<usize> where P: FnMut(Self::Item) -> bool, Self: ExactSizeIterator + DoubleEndedIterator

fn max(self) -> Option<Self::Item> where Self::Item: Ord

fn min(self) -> Option<Self::Item> where Self::Item: Ord

fn max_by<B, F>(self, f: F) -> Option<Self::Item> where F: FnMut(&Self::Item) -> B, B: Ord

fn min_by<B, F>(self, f: F) -> Option<Self::Item> where B: Ord, F: FnMut(&Self::Item) -> B

fn rev(self) -> Rev<Self> where Self: DoubleEndedIterator

fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB) where Self: Iterator<Item=(A, B)>, FromA: Default + Extend<A>, FromB: Default + Extend<B>

fn cloned<'a, T>(self) -> Cloned<Self> where T: 'a + Clone, Self: Iterator<Item=&'a T>

fn cycle(self) -> Cycle<Self> where Self: Clone

fn sum<S = Self::Item>(self) -> S where S: Add<Self::Item, Output=S> + Zero

fn product<P = Self::Item>(self) -> P where P: Mul<Self::Item, Output=P> + One

fn cmp<I>(self, other: I) -> Ordering where I: IntoIterator<Item=Self::Item>, Self::Item: Ord

fn partial_cmp<I>(self, other: I) -> Option<Ordering> where I: IntoIterator, Self::Item: PartialOrd<I::Item>

fn eq<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialEq<I::Item>

fn ne<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialEq<I::Item>

fn lt<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialOrd<I::Item>

fn le<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialOrd<I::Item>

fn gt<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialOrd<I::Item>

fn ge<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialOrd<I::Item>