Struct Platform

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

An intermediate structure to hold shared state alive long enough for iteration to happen.

Implementations

impl<'repo> Platform<'repo>

pub fn all<'p>(&'p self) -> Result<LooseThenPacked<'p, 'repo>>

Return an iterator over all references, loose or packed, sorted by their name.

Errors are returned similarly to what would happen when loose and packed refs were iterated by themselves.

pub fn prefixed<'p>( &'p self, prefix: &RelativePath, ) -> Result<LooseThenPacked<'p, 'repo>>

As iter(…), but filters by prefix, i.e. “refs/heads/” or “refs/heads/feature-”.

Note that if a prefix isn’t using a trailing /, like in refs/heads/foo, it will effectively start the traversal in the parent directory, e.g. refs/heads/ and list everything inside that starts with foo, like refs/heads/foo and refs/heads/foobar.

Prefixes are relative paths with slash-separated components.

pub fn pseudo<'p>(&'p self) -> Result<LooseThenPacked<'p, 'repo>>

Return an iterator over the pseudo references, like HEAD or FETCH_HEAD, or anything else suffixed with HEAD in the root of the .git directory, sorted by name.