Skip to main content

ColorProfile

Enum ColorProfile 

Source
pub enum ColorProfile {
    Mono,
    Ansi16,
    Ansi256,
    TrueColor,
}
Expand description

Terminal color profile used for downgrade decisions.

Variants§

§

Mono

No color output.

§

Ansi16

Standard 16 ANSI colors.

§

Ansi256

Extended 256-color palette.

§

TrueColor

Full 24-bit RGB color.

Implementations§

Source§

impl ColorProfile

Source

pub fn detect() -> Self

Auto-detect the best available color profile from environment variables.

Detection priority:

  1. NO_COLOR set → Mono
  2. COLORTERM=truecolor or COLORTERM=24bitTrueColor
  3. TERM contains “256” → Ansi256
  4. Otherwise → Ansi16
§Example
use ftui_style::ColorProfile;

let profile = ColorProfile::detect();
if profile.supports_true_color() {
    println!("Full 24-bit color available!");
}
Source

pub fn detect_from_env( no_color: Option<&str>, colorterm: Option<&str>, term: Option<&str>, ) -> Self

Detect color profile from provided environment values (for testing).

Pass Some("") for empty env vars or None for unset.

Source

pub const fn from_flags( true_color: bool, colors_256: bool, no_color: bool, ) -> Self

Choose the best available profile from detection flags.

no_color should reflect explicit user intent (e.g. NO_COLOR).

Source

pub const fn supports_true_color(self) -> bool

Check if this profile supports 24-bit true color.

Source

pub const fn supports_256_colors(self) -> bool

Check if this profile supports 256 colors or more.

Source

pub const fn supports_color(self) -> bool

Check if this profile supports any color (not monochrome).

Trait Implementations§

Source§

impl Clone for ColorProfile

Source§

fn clone(&self) -> ColorProfile

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ColorProfile

Source§

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

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

impl Hash for ColorProfile

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for ColorProfile

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Copy for ColorProfile

Source§

impl Eq for ColorProfile

Source§

impl StructuralPartialEq for ColorProfile

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more