Struct git2::ReferenceFormat

pub struct ReferenceFormat { /* fields omitted */ }

Options for Reference::normalize_name.

Implementations

impl ReferenceFormat

pub const NORMAL: ReferenceFormat

No particular normalization.

pub const ALLOW_ONELEVEL: ReferenceFormat

Constrol whether one-level refname are accepted (i.e., refnames that do not contain multiple /-separated components). Those are expected to be written only using uppercase letters and underscore (e.g. HEAD, FETCH_HEAD).

pub const REFSPEC_PATTERN: ReferenceFormat

Interpret the provided name as a reference pattern for a refspec (as used with remote repositories). If this option is enabled, the name is allowed to contain a single * in place of a full pathname components (e.g., foo/*/bar but not foo/bar*).

pub const REFSPEC_SHORTHAND: ReferenceFormat

Interpret the name as part of a refspec in shorthand form so the ALLOW_ONELEVEL naming rules aren't enforced and main becomes a valid name.

pub const fn empty() -> ReferenceFormat

Returns an empty set of flags

pub const fn all() -> ReferenceFormat

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<ReferenceFormat>

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

pub const fn from_bits_truncate(bits: u32) -> ReferenceFormat

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

pub const unsafe fn from_bits_unchecked(bits: u32) -> ReferenceFormat

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: ReferenceFormat) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

impl ReferenceFormat

pub fn is_allow_onelevel(&self) -> bool

pub fn is_refspec_pattern(&self) -> bool

pub fn is_refspec_shorthand(&self) -> bool

Trait Implementations

impl Binary for ReferenceFormat

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

Formats the value using the given formatter.

impl BitAnd<ReferenceFormat> for ReferenceFormat

type Output = ReferenceFormat

The resulting type after applying the & operator.

pub fn bitand(self, other: ReferenceFormat) -> ReferenceFormat

Returns the intersection between the two sets of flags.

impl BitAndAssign<ReferenceFormat> for ReferenceFormat

pub fn bitand_assign(&mut self, other: ReferenceFormat)

Disables all flags disabled in the set.

impl BitOr<ReferenceFormat> for ReferenceFormat

type Output = ReferenceFormat

The resulting type after applying the | operator.

pub fn bitor(self, other: ReferenceFormat) -> ReferenceFormat

Returns the union of the two sets of flags.

impl BitOrAssign<ReferenceFormat> for ReferenceFormat

pub fn bitor_assign(&mut self, other: ReferenceFormat)

Adds the set of flags.

impl BitXor<ReferenceFormat> for ReferenceFormat

type Output = ReferenceFormat

The resulting type after applying the ^ operator.

pub fn bitxor(self, other: ReferenceFormat) -> ReferenceFormat

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

impl BitXorAssign<ReferenceFormat> for ReferenceFormat

pub fn bitxor_assign(&mut self, other: ReferenceFormat)

Toggles the set of flags.

impl Clone for ReferenceFormat

pub fn clone(&self) -> ReferenceFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ReferenceFormat

impl Debug for ReferenceFormat

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

Formats the value using the given formatter.

impl Default for ReferenceFormat

pub fn default() -> Self

Returns the "default value" for a type.

impl Eq for ReferenceFormat

impl Extend<ReferenceFormat> for ReferenceFormat

pub fn extend<T: IntoIterator<Item = ReferenceFormat>>(&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<ReferenceFormat> for ReferenceFormat

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

Creates a value from an iterator.

impl Hash for ReferenceFormat

pub 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 ReferenceFormat

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

Formats the value using the given formatter.

impl Not for ReferenceFormat

type Output = ReferenceFormat

The resulting type after applying the ! operator.

pub fn not(self) -> ReferenceFormat

Returns the complement of this set of flags.

impl Octal for ReferenceFormat

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

Formats the value using the given formatter.

impl Ord for ReferenceFormat

pub fn cmp(&self, other: &ReferenceFormat) -> 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<ReferenceFormat> for ReferenceFormat

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

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

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

This method tests for !=.

impl PartialOrd<ReferenceFormat> for ReferenceFormat

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

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

pub fn lt(&self, other: &ReferenceFormat) -> bool

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

pub fn le(&self, other: &ReferenceFormat) -> bool

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

pub fn gt(&self, other: &ReferenceFormat) -> bool

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

pub fn ge(&self, other: &ReferenceFormat) -> bool

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

impl StructuralEq for ReferenceFormat

impl StructuralPartialEq for ReferenceFormat

impl Sub<ReferenceFormat> for ReferenceFormat

type Output = ReferenceFormat

The resulting type after applying the - operator.

pub fn sub(self, other: ReferenceFormat) -> ReferenceFormat

Returns the set difference of the two sets of flags.

impl SubAssign<ReferenceFormat> for ReferenceFormat

pub fn sub_assign(&mut self, other: ReferenceFormat)

Disables all flags enabled in the set.

impl UpperHex for ReferenceFormat

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

Formats the value using the given formatter.