Enum SpecificInfo

#[non_exhaustive]
pub enum SpecificInfo<'a> {
    Git {
        commit_hash: &'a str,
        extra: Option<&'a ExtraData<'a>>,
    },
    Mercurial {
        global_revision: &'a str,
        extra: Option<&'a ExtraData<'a>>,
    },
}

Contains information which is specific to a version control program.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Git

Contains information about a git repository.

Fields

commit_hash: &'a str

The full commit hash.

extra: Option<&'a ExtraData<'a>>

Extra metadata about the git repository, if available.

See the definition of GitExtraData for more details.

Mercurial

Contains information about a Mercurial repository.

Fields

global_revision: &'a str

Global revision number.

extra: Option<&'a ExtraData<'a>>

Extra metadata about the Mercurial repository.

See the definition of MercurialExtraData for more details.

Implementations

impl<'a> SpecificInfo<'a>

pub const fn commit(&self) -> &str

Returns the full remote commit hash string from the SpecificInfo for the current commit which this crate was built from.

pub const fn tags(&self) -> Option<&[&str]>

Returns the list of tags associated with the current commit.

• Returns None if the tag information could not be found.
• Returns Some(&[]) if there are no tags associated with the commit.

Trait Implementations

impl<'a> Clone for SpecificInfo<'a>

fn clone(&self) -> SpecificInfo<'a>

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for SpecificInfo<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Hash for SpecificInfo<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for SpecificInfo<'a>

fn eq(&self, other: &SpecificInfo<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Copy for SpecificInfo<'a>

impl<'a> Eq for SpecificInfo<'a>

impl<'a> StructuralPartialEq for SpecificInfo<'a>