Struct gix_config::color::Attribute

pub struct Attribute(_);

Discriminating enum for Color attributes.

gix-config supports modifiers and their negators. The negating color attributes are equivalent to having a no or no- prefix to the normal variant.

Implementations

impl Attribute

pub const BOLD: Attribute = Self::from_bits_retain(1 << 1)

pub const DIM: Attribute = Self::from_bits_retain(1 << 2)

pub const ITALIC: Attribute = Self::from_bits_retain(1 << 3)

pub const UL: Attribute = Self::from_bits_retain(1 << 4)

pub const BLINK: Attribute = Self::from_bits_retain(1 << 5)

pub const REVERSE: Attribute = Self::from_bits_retain(1 << 6)

pub const STRIKE: Attribute = Self::from_bits_retain(1 << 7)

pub const RESET: Attribute = Self::from_bits_retain(1 << 8)

Reset is special as we have to be able to parse it, without git actually doing anything with it

pub const NO_DIM: Attribute = Self::from_bits_retain(1 << 21)

pub const NO_BOLD: Attribute = Self::from_bits_retain(1 << 22)

pub const NO_ITALIC: Attribute = Self::from_bits_retain(1 << 23)

pub const NO_UL: Attribute = Self::from_bits_retain(1 << 24)

pub const NO_BLINK: Attribute = Self::from_bits_retain(1 << 25)

pub const NO_REVERSE: Attribute = Self::from_bits_retain(1 << 26)

pub const NO_STRIKE: Attribute = Self::from_bits_retain(1 << 27)

impl Attribute

pub const fn empty() -> Attribute

Returns an empty set of flags.

pub const fn all() -> Attribute

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

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) -> Attribute

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

pub const fn from_bits_retain(bits: u32) -> Attribute

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

pub fn from_name(name: &str) -> Option<Attribute>

Get the value for a flag from its stringified name.

Names are case-sensitive, so must correspond exactly to the identifier given to the 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: Attribute) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

pub const fn intersection(self, other: Attribute) -> Attribute

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

pub const fn union(self, other: Attribute) -> Attribute

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

pub const fn difference(self, other: Attribute) -> Attribute

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

pub const fn symmetric_difference(self, other: Attribute) -> Attribute

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> Attribute

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

impl Attribute

pub const fn iter(&self) -> Iter<Attribute>

Iterate over enabled flag values.

pub const fn iter_names(&self) -> IterNames<Attribute>

Iterate over enabled flag values with their stringified names.

Trait Implementations

impl Binary for Attribute

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

Formats the value using the given formatter.

impl BitAnd<Attribute> for Attribute

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

Returns the intersection between the two sets of flags.

type Output = Attribute

The resulting type after applying the & operator.

impl BitAndAssign<Attribute> for Attribute

fn bitand_assign(&mut self, other: Attribute)

Disables all flags disabled in the set.

impl BitOr<Attribute> for Attribute

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

Returns the union of the two sets of flags.

type Output = Attribute

The resulting type after applying the | operator.

impl BitOrAssign<Attribute> for Attribute

fn bitor_assign(&mut self, other: Attribute)

Adds the set of flags.

impl BitXor<Attribute> for Attribute

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

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

type Output = Attribute

The resulting type after applying the ^ operator.

impl BitXorAssign<Attribute> for Attribute

fn bitxor_assign(&mut self, other: Attribute)

Toggles the set of flags.

impl Clone for Attribute

fn clone(&self) -> Attribute

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Attribute

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

Formats the value using the given formatter.

impl Default for Attribute

fn default() -> Attribute

Returns the “default value” for a type.

impl Display for Attribute

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

Formats the value using the given formatter.

impl Extend<Attribute> for Attribute

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

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 Flags for Attribute

const FLAGS: &'static [Flag<Attribute>] = &[{ ::bitflags::Flag::new("BOLD", Attribute::BOLD) }, { ::bitflags::Flag::new("DIM", Attribute::DIM) }, { ::bitflags::Flag::new("ITALIC", Attribute::ITALIC) }, { ::bitflags::Flag::new("UL", Attribute::UL) }, { ::bitflags::Flag::new("BLINK", Attribute::BLINK) }, { ::bitflags::Flag::new("REVERSE", Attribute::REVERSE) }, { ::bitflags::Flag::new("STRIKE", Attribute::STRIKE) }, { ::bitflags::Flag::new("RESET", Attribute::RESET) }, { ::bitflags::Flag::new("NO_DIM", Attribute::NO_DIM) }, { ::bitflags::Flag::new("NO_BOLD", Attribute::NO_BOLD) }, { ::bitflags::Flag::new("NO_ITALIC", Attribute::NO_ITALIC) }, { ::bitflags::Flag::new("NO_UL", Attribute::NO_UL) }, { ::bitflags::Flag::new("NO_BLINK", Attribute::NO_BLINK) }, { ::bitflags::Flag::new("NO_REVERSE", Attribute::NO_REVERSE) }, { ::bitflags::Flag::new("NO_STRIKE", Attribute::NO_STRIKE) }]

The set of available flags and their names.

type Bits = u32

The underlying storage type.

fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

fn from_bits_retain(bits: u32) -> Attribute

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

fn empty() -> Self

Returns an empty set of flags.

fn all() -> Self

Returns the set containing all flags.

fn from_bits(bits: Self::Bits) -> Option<Self>

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

fn from_bits_truncate(bits: Self::Bits) -> Self

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

fn from_name(name: &str) -> Option<Self>

Get the flag for a particular name.

fn iter(&self) -> Iter<Self>

Iterate over enabled flag values.

fn iter_names(&self) -> IterNames<Self>

Iterate over the raw names and bits for enabled flag values.

fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

fn is_all(&self) -> bool

Returns true if all flags are currently set.

fn intersects(&self, other: Self) -> boolwhere Self: Sized,

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

fn contains(&self, other: Self) -> boolwhere Self: Sized,

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

fn insert(&mut self, other: Self)where Self: Sized,

Inserts the specified flags in-place.

fn remove(&mut self, other: Self)where Self: Sized,

Removes the specified flags in-place.

fn toggle(&mut self, other: Self)where Self: Sized,

Toggles the specified flags in-place.

fn set(&mut self, other: Self, value: bool)where Self: Sized,

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

fn intersection(self, other: Self) -> Self

Returns the intersection between the flags in self and other.

fn union(self, other: Self) -> Self

Returns the union of between the flags in self and other.

fn difference(self, other: Self) -> Self

Returns the difference between the flags in self and other.

fn symmetric_difference(self, other: Self) -> Self

Returns the symmetric difference between the flags in self and other.

fn complement(self) -> Self

Returns the complement of this set of flags.

impl FromIterator<Attribute> for Attribute

fn from_iter<T>(iterator: T) -> Attributewhere T: IntoIterator<Item = Attribute>,

Creates a value from an iterator.

impl FromStr for Attribute

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Attribute, <Attribute as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Attribute

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

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 IntoIterator for Attribute

type Item = Attribute

The type of the elements being iterated over.

type IntoIter = Iter<Attribute>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Attribute as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for Attribute

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

Formats the value using the given formatter.

impl Not for Attribute

fn not(self) -> Attribute

Returns the complement of this set of flags.

type Output = Attribute

The resulting type after applying the ! operator.

impl Octal for Attribute

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

Formats the value using the given formatter.

impl Ord for Attribute

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Attribute> for Attribute

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

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

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

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

impl PartialOrd<Attribute> for Attribute

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

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

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

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

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

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

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

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

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 Serialize for Attribute

Available on crate feature serde only.

fn serialize<S>( &self, serializer: S ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<Attribute> for Attribute

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

Returns the set difference of the two sets of flags.

type Output = Attribute

The resulting type after applying the - operator.

impl SubAssign<Attribute> for Attribute

fn sub_assign(&mut self, other: Attribute)

Disables all flags enabled in the set.

impl TryFrom<&BStr> for Attribute

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &BStr) -> Result<Attribute, <Attribute as TryFrom<&BStr>>::Error>

Performs the conversion.

impl UpperHex for Attribute

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

Formats the value using the given formatter.

impl Copy for Attribute

impl Eq for Attribute

impl StructuralEq for Attribute

impl StructuralPartialEq for Attribute