Struct git_repository::commit::describe::Platform

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

A support type to allow configuring a git describe operation

Implementations

impl<'repo> Platform<'repo>

pub fn names(self, select: SelectRef) -> Self

Configure which names to select from which describe can chose.

pub fn traverse_first_parent(self, first_parent: bool) -> Self

If true, shorten the graph traversal time by just traversing the first parent of merge commits.

pub fn max_candidates(self, candidates: usize) -> Self

Only consider the given amount of candidates, instead of the default of 10.

pub fn id_as_fallback(self, use_fallback: bool) -> Self

If true, even if no candidate is available a format will always be produced.

pub fn try_format(&self) -> Result<Option<Format<'static>>, Error>

Try to find a name for the configured commit id using all prior configuration, returning Some(describe::Format) if one was found.

Note that there will always be Some(format)

pub fn try_resolve(&self) -> Result<Option<Resolution<'repo>>, Error>

Try to find a name for the configured commit id using all prior configuration, returning Some(Outcome) if one was found.

The outcome provides additional information, but leaves the caller with the burden

pub fn format(&mut self) -> Result<Format<'static>, Error>

Like try_format(), but turns id_as_fallback() on to always produce a format.