Skip to main content

CellColor

Struct CellColor 

Source
pub struct CellColor(/* private fields */);
Expand description

One packed color value. All-zero = terminal default (no escape).

Implementations§

Source§

impl CellColor

Source

pub const DEFAULT: CellColor

Terminal default — no escape emitted.

Source

pub const fn ansi256(index: u8) -> CellColor

An ANSI-256 palette color.

Source

pub const fn rgb(r: u8, g: u8, b: u8) -> CellColor

A 24-bit RGB color.

Source

pub fn is_set(self) -> bool

Whether this is a real color (an escape will be emitted).

Source

pub fn as_ansi256(self) -> Option<u8>

This color as an ANSI-256 index, quantizing RGB if needed. Returns None for CellColor::DEFAULT (the consumer’s “no color set” — use its own default ink).

Source

pub fn as_rgb(self) -> Option<(u8, u8, u8)>

This color as RGB, expanding an ANSI index if needed. Returns None for CellColor::DEFAULT (the consumer’s “no color set” — use its own default ink). This is what an SVG/TUI consumer feeds its own color model.

Examples found in repository?
examples/svg_export.rs (line 27)
26fn css(color: ascii_dag::CellColor) -> String {
27    match color.as_rgb() {
28        Some((r, g, b)) => format!("rgb({r},{g},{b})"),
29        None => "currentColor".into(),
30    }
31}

Trait Implementations§

Source§

impl Clone for CellColor

Source§

fn clone(&self) -> CellColor

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for CellColor

Source§

impl Debug for CellColor

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CellColor

Source§

fn default() -> CellColor

Returns the “default value” for a type. Read more
Source§

impl Eq for CellColor

Source§

impl PartialEq for CellColor

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CellColor

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.