Struct vergen::ConstantsFlags

pub struct ConstantsFlags { /* fields omitted */ }

Constants Flags

Use these to toggle off the generation of constants you won't use.

let mut actual_flags = ConstantsFlags::all();
actual_flags.toggle(ConstantsFlags::SHA_SHORT);
actual_flags.toggle(ConstantsFlags::BUILD_DATE);
actual_flags.toggle(ConstantsFlags::SEMVER_LIGHTWEIGHT);
actual_flags.toggle(ConstantsFlags::SEMVER_FROM_CARGO_PKG);

let expected_flags = ConstantsFlags::BUILD_TIMESTAMP |
    ConstantsFlags::SHA |
    ConstantsFlags::COMMIT_DATE |
    ConstantsFlags::RUSTC_HOST_TRIPLE |
    ConstantsFlags::SEMVER |
    ConstantsFlags::RUSTC_SEMVER |
    ConstantsFlags::RUSTC_CHANNEL |
    ConstantsFlags::REBUILD_ON_HEAD_CHANGE |
    ConstantsFlags::BRANCH |
    ConstantsFlags::RUSTC_COMMIT_HASH |
    ConstantsFlags::RUSTC_COMMIT_DATE |
    ConstantsFlags::RUSTC_LLVM_VERSION;

assert_eq!(actual_flags, expected_flags)

Implementations

impl ConstantsFlags

pub const BUILD_TIMESTAMP: ConstantsFlags

Generate the build timestamp constant.

2018-08-09T15:15:57.282334589+00:00

pub const BUILD_DATE: ConstantsFlags

Generate the build date constant.

2018-08-09

pub const SHA: ConstantsFlags

Generate the SHA constant.

75b390dc6c05a6a4aa2791cc7b3934591803bc22

pub const SHA_SHORT: ConstantsFlags

Generate the short SHA constant.

75b390d

pub const COMMIT_DATE: ConstantsFlags

Generate the commit date constant.

2018-08-08

pub const SEMVER: ConstantsFlags

Generate the semver constant.

This defaults to the output of git describe. If that output is empty, the the CARGO_PKG_VERSION environment variable is used.

v0.1.0

pub const SEMVER_LIGHTWEIGHT: ConstantsFlags

Generate the semver constant, including lightweight tags.

This defaults to the output of git describe --tags. If that output is empty, the the CARGO_PKG_VERSION environment variable is used.

v0.1.0

pub const REBUILD_ON_HEAD_CHANGE: ConstantsFlags

Generate the cargo:rebuild-if-changed=.git/HEAD and the cargo:rebuild-if-changed=.git/<ref> cargo build output.

pub const SEMVER_FROM_CARGO_PKG: ConstantsFlags

Generate the semver constant from CARGO_PKG_VERSION. This is mutually exclusive with the SEMVER flag.

0.1.0

pub const RUSTC_SEMVER: ConstantsFlags

Generates the rustc compiler version.

1.43.1

pub const RUSTC_CHANNEL: ConstantsFlags

Generates the channel the rust compiler is installed from.

nightly

pub const RUSTC_HOST_TRIPLE: ConstantsFlags

Generate the host triple constant.

x86_64-unknown-linux-gnu

pub const BRANCH: ConstantsFlags

Generate the branch name constant.

master

pub const RUSTC_COMMIT_HASH: ConstantsFlags

Generates the rustc commit hash

abcdef123

pub const RUSTC_COMMIT_DATE: ConstantsFlags

Generates the rustc commit date

01/22/21

pub const RUSTC_LLVM_VERSION: ConstantsFlags

1.2.3

pub const fn empty() -> ConstantsFlags

Returns an empty set of flags

pub const fn all() -> ConstantsFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u64

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u64) -> Option<ConstantsFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u64) -> ConstantsFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u64) -> ConstantsFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: ConstantsFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: ConstantsFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: ConstantsFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: ConstantsFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: ConstantsFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: ConstantsFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for ConstantsFlags

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

Formats the value using the given formatter.

impl BitAnd<ConstantsFlags> for ConstantsFlags

type Output = ConstantsFlags

The resulting type after applying the & operator.

fn bitand(self, other: ConstantsFlags) -> ConstantsFlags

Returns the intersection between the two sets of flags.

impl BitAndAssign<ConstantsFlags> for ConstantsFlags

fn bitand_assign(&mut self, other: ConstantsFlags)

Disables all flags disabled in the set.

impl BitOr<ConstantsFlags> for ConstantsFlags

type Output = ConstantsFlags

The resulting type after applying the | operator.

fn bitor(self, other: ConstantsFlags) -> ConstantsFlags

Returns the union of the two sets of flags.

impl BitOrAssign<ConstantsFlags> for ConstantsFlags

fn bitor_assign(&mut self, other: ConstantsFlags)

Adds the set of flags.

impl BitXor<ConstantsFlags> for ConstantsFlags

type Output = ConstantsFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: ConstantsFlags) -> ConstantsFlags

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<ConstantsFlags> for ConstantsFlags

fn bitxor_assign(&mut self, other: ConstantsFlags)

Toggles the set of flags.

impl Clone for ConstantsFlags

fn clone(&self) -> ConstantsFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ConstantsFlags

impl Debug for ConstantsFlags

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

Formats the value using the given formatter.

impl Eq for ConstantsFlags

impl Extend<ConstantsFlags> for ConstantsFlags

fn extend<T: IntoIterator<Item = ConstantsFlags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<ConstantsFlags> for ConstantsFlags

fn from_iter<T: IntoIterator<Item = ConstantsFlags>>(
    iterator: T
) -> ConstantsFlags

Creates a value from an iterator.

impl Hash for ConstantsFlags

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl LowerHex for ConstantsFlags

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

Formats the value using the given formatter.

impl Not for ConstantsFlags

type Output = ConstantsFlags

The resulting type after applying the ! operator.

fn not(self) -> ConstantsFlags

Returns the complement of this set of flags.

impl Octal for ConstantsFlags

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

Formats the value using the given formatter.

impl Ord for ConstantsFlags

fn cmp(&self, other: &ConstantsFlags) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ConstantsFlags> for ConstantsFlags

fn eq(&self, other: &ConstantsFlags) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<ConstantsFlags> for ConstantsFlags

fn partial_cmp(&self, other: &ConstantsFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for ConstantsFlags

impl StructuralPartialEq for ConstantsFlags

impl Sub<ConstantsFlags> for ConstantsFlags

type Output = ConstantsFlags

The resulting type after applying the - operator.

fn sub(self, other: ConstantsFlags) -> ConstantsFlags

Returns the set difference of the two sets of flags.

impl SubAssign<ConstantsFlags> for ConstantsFlags

fn sub_assign(&mut self, other: ConstantsFlags)

Disables all flags enabled in the set.

impl UpperHex for ConstantsFlags

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

Formats the value using the given formatter.