Enum ThemeEntry 

pub enum ThemeEntry {
    Ansi(AnsiColor),
    DefaultForeground(),
    DefaultBackground(),
}

A color theme entry.

This enumeration combines a variant wrapping an AnsiColor with two more variants for the default foreground and background colors to identify the ThemeEntry::COUNT entries of a color theme. Displaying a theme entry produces the ANSI escape sequence used to query a terminal for the corresponding color.

Variants

Ansi(AnsiColor)

DefaultForeground()

DefaultBackground()

Implementations

impl ThemeEntry

pub const COUNT: usize = 18

The total number of theme entries.

pub fn all() -> ThemeEntryIterator

Create a new iterator over all theme entries in canonical order.

impl ThemeEntry

pub fn name(&self) -> &'static str

Get this theme entry’s human-readable name.

pub fn abbr(&self) -> &'static str

Get an abbreviation for this theme entry’s name.

This method returns a two-letter abbreviations for this theme entry. See AnsiColor::abbr for a description of the abbreviations for ANSI colors.

impl ThemeEntry

pub fn request(&self) -> RequestColor

Convert the theme entry to a color request. TTY only!

Trait Implementations

impl Clone for ThemeEntry

fn clone(&self) -> ThemeEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ThemeEntry

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

Formats the value using the given formatter.

impl Display for ThemeEntry

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

Get an ANSI escape sequence to query a terminal for this theme entry’s current color.

impl From<AnsiColor> for ThemeEntry

fn from(value: AnsiColor) -> Self

Converts to this type from the input type.

impl Hash for ThemeEntry

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 Index<ThemeEntry> for Theme

type Output = Color

The returned type after indexing.

fn index(&self, index: ThemeEntry) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<ThemeEntry> for Theme

fn index_mut(&mut self, index: ThemeEntry) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl Ord for ThemeEntry

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ThemeEntry

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ThemeEntry

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Query for ThemeEntry

Available on crate feature tty only.

Theme entry as a query. TTY only!

type Response = Color

The type of the response data.

fn control(&self) -> Control

Get the response’s control.

fn parse(&self, payload: &[u8]) -> Result<Self::Response>

Parse the payload into a response object.

fn run( &self, input: &mut Input<'_>, output: &mut Output<'_>, ) -> Result<Self::Response, Error>

Run this query.

impl TryFrom<usize> for ThemeEntry

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Command for ThemeEntry

Available on crate feature tty only.

Theme entry as a command. TTY only!

impl Copy for ThemeEntry

impl Eq for ThemeEntry

impl StructuralPartialEq for ThemeEntry