Struct git_config::values::Color

pub struct Color {
    pub foreground: Option<ColorValue>,
    pub background: Option<ColorValue>,
    pub attributes: Vec<ColorAttribute>,
}

Any value that may contain a foreground color, background color, a collection of color (text) modifiers, or a combination of any of the aforementioned values.

Note that git-config allows color values to simply be a collection of ColorAttributes, and does not require a ColorValue for either the foreground or background color.

Fields

foreground: Option<ColorValue>

A provided foreground color

background: Option<ColorValue>

A provided background color

attributes: Vec<ColorAttribute>

A potentially empty list of text attributes

Implementations

impl Color

#[must_use]pub fn to_vec(&self) -> Vec<u8>

Generates a byte representation of the value. This should be used when non-UTF-8 sequences are present or a UTF-8 representation can’t be guaranteed.

Trait Implementations

impl Clone for Color

fn clone(&self) -> Color

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Color

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

Formats the value using the given formatter.

impl Default for Color

fn default() -> Color

Returns the “default value” for a type.

impl Display for Color

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

Formats the value using the given formatter.

impl Eq for Color

impl FromStr for Color

type Err = ColorParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for Color

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 Into<Vec<u8, Global>> for Color

fn into(self) -> Vec<u8>

Performs the conversion.

impl Into<Vec<u8, Global>> for &Color

fn into(self) -> Vec<u8>

Performs the conversion.

impl Ord for Color

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

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

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

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

This method tests for !=.

impl PartialOrd<Color> for Color

fn partial_cmp(&self, other: &Color) -> 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 Color

impl StructuralPartialEq for Color

impl TryFrom<&'_ [u8]> for Color

type Error = ()

The type returned in the event of a conversion error.

fn try_from(s: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Cow<'_, [u8]>> for Color

type Error = ()

The type returned in the event of a conversion error.

fn try_from(c: Cow<'_, [u8]>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<u8, Global>> for Color

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.