Struct base16_color_scheme::scheme::RgbColorFormatter

pub struct RgbColorFormatter {
    pub color: RgbColor,
    pub format: Format,
}

formatter that formats a color according to the specification

This formatter contains a color and a specifier in what format this color should be formatted.

Example

use base16_color_scheme::{
    scheme::{RgbColor, RgbColorFormatter},
    template::color_field::{Dec, Format, Hex, Hsl, Rgb},
};

let color = RgbColor([0x7c, 0xaf, 0xc2]);

// This macro is used to test the result of format!("{}") in a much more readable fashion
rgb_formatter_eq! {
    color,
    Format::Hex(Hex::Rgb), "7cafc2";
    Format::Hex(Hex::R),   "7c";
    Format::Hex(Hex::G),   "af";
    Format::Hex(Hex::B),   "c2";
    Format::Hex(Hex::Bgr), "c2af7c";
    Format::Rgb(Rgb::R),   "124";
    Format::Rgb(Rgb::G),   "175";
    Format::Rgb(Rgb::B),   "194";
    Format::Dec(Dec::R),   "0.49";
    Format::Dec(Dec::G),   "0.69";
    Format::Dec(Dec::B),   "0.76";
    Format::Hsl(Hsl::H),   "196.29";
    Format::Hsl(Hsl::S),   "0.36";
    Format::Hsl(Hsl::L),   "0.62";
}

Fields

color: RgbColor

format: Format

Trait Implementations

impl Clone for RgbColorFormatter

fn clone(&self) -> RgbColorFormatter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Content for RgbColorFormatter

fn is_truthy(&self) -> bool

Marks whether this content is truthy. Used when attempting to render a section.

fn render_escaped<E: Encoder>(&self, encoder: &mut E) -> Result<(), E::Error>

Renders self as a variable to the encoder.

fn capacity_hint(&self, _tpl: &Template<'_>) -> usize

How much capacity is likely required for all the data in this Content for a given Template.

fn render_unescaped<E>( &self, encoder: &mut E ) -> Result<(), <E as Encoder>::Error>where E: Encoder,

Renders self as a variable to the encoder.

fn render_section<C, E>( &self, section: Section<'_, C>, encoder: &mut E ) -> Result<(), <E as Encoder>::Error>where C: ContentSequence, E: Encoder,

Render a section with self.

fn render_inverse<C, E>( &self, section: Section<'_, C>, encoder: &mut E ) -> Result<(), <E as Encoder>::Error>where C: ContentSequence, E: Encoder,

Render a section with self.

fn render_field_escaped<E>( &self, _hash: u64, _name: &str, _encoder: &mut E ) -> Result<bool, <E as Encoder>::Error>where E: Encoder,

Render a field by the hash or string of its name.

fn render_field_unescaped<E>( &self, _hash: u64, _name: &str, _encoder: &mut E ) -> Result<bool, <E as Encoder>::Error>where E: Encoder,

Render a field by the hash or string of its name.

fn render_field_section<C, E>( &self, _hash: u64, _name: &str, _section: Section<'_, C>, _encoder: &mut E ) -> Result<bool, <E as Encoder>::Error>where C: ContentSequence, E: Encoder,

Render a field by the hash or string of its name, as a section. If successful, returns true if the field exists in this content, otherwise false.

fn render_field_inverse<C, E>( &self, _hash: u64, _name: &str, _section: Section<'_, C>, _encoder: &mut E ) -> Result<bool, <E as Encoder>::Error>where C: ContentSequence, E: Encoder,

Render a field, by the hash of or string its name, as an inverse section. If successful, returns true if the field exists in this content, otherwise false.

impl Debug for RgbColorFormatter

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

Formats the value using the given formatter.

impl Display for RgbColorFormatter

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

Formats the value using the given formatter.

impl Hash for RgbColorFormatter

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 Ord for RgbColorFormatter

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

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

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

impl Eq for RgbColorFormatter

impl StructuralEq for RgbColorFormatter

impl StructuralPartialEq for RgbColorFormatter