prettypretty::termco

Enum AnsiColor

Source
pub enum AnsiColor {
Show 16 variants Black, Red, Green, Yellow, Blue, Magenta, Cyan, White, BrightBlack, BrightRed, BrightGreen, BrightYellow, BrightBlue, BrightMagenta, BrightCyan, BrightWhite,
}
Expand description

The 16 extended ANSI colors.

Rust code converts between 8-bit color codes and enumeration variants with AnsiColor as TryFrom<u8> and u8 as From<AnsiColor>. In contrast, Python code uses the AnsiColor::try_from_8bit and AnsiColor::to_8bit methods. Since ANSI colors have no intrinsic color values, conversion from/to high-resolution colors requires additional machinery, as provided by Translator.

The ANSI colors are ordered because they are ordered as theme colors and as indexed colors.

Variants§

§

Black

§

Red

§

Green

§

Yellow

§

Blue

§

Magenta

§

Cyan

§

White

§

BrightBlack

§

BrightRed

§

BrightGreen

§

BrightYellow

§

BrightBlue

§

BrightMagenta

§

BrightCyan

§

BrightWhite

Implementations§

Source§

impl AnsiColor

Source

pub fn all() -> AnsiColorIterator

Get an iterator over all ANSI colors in order.

Source

pub fn try_from_8bit(value: u8) -> Result<Self, OutOfBoundsError>

Instantiate an ANSI color from its 8-bit code. Python only!

This method offers the same functionality as AnsiColor as TryFrom<u8> and is available in Python only.

Source

pub fn to_8bit(&self) -> u8

Get the 8-bit code for this ANSI color. Python only!

This method offers the same functionality as u8 as From<AnsiColor> and is available in Python only.

Source

pub fn is_achromatic(&self) -> bool

Determine whether this ANSI color is achromatic.

Source

pub fn is_bright(&self) -> bool

Determine whether this ANSI color is bright.

Source

pub fn to_base(&self) -> Self

Get the base version of this ANSI color.

If this color is bright, this method returns its non-bright version. Otherwise, it returns the same color.

Source

pub fn to_bright(&self) -> Self

Get the bright version of this ANSI color.

If the color is not bright, this method returns its bright version. Otherwise, it returns the same color.

Source

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

Get this ANSI color’s name.

This method returns the human-readable name, e.g., "bright green" for AnsiColor::BrightGreen.

Source

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

Get an abbreviation for this ANSI color.

This method returns a two-letter abbreviation for this ANSI color. The abbreviations for each pair of nonbright and bright colors only differ in case, with the nonbright color’s abbreviation in lower case and the bright color’s abbreviation in upper case.

Trait Implementations§

Source§

impl Clone for AnsiColor

Source§

fn clone(&self) -> AnsiColor

Returns a copy 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 AnsiColor

Source§

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

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

impl Default for AnsiColor

Source§

fn default() -> AnsiColor

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

impl From<AnsiColor> for Colorant

Source§

fn from(value: AnsiColor) -> Self

Converts to this type from the input type.
Source§

impl From<AnsiColor> for EightBitColor

Source§

fn from(value: AnsiColor) -> Self

Converts to this type from the input type.
Source§

impl From<AnsiColor> for ThemeEntry

Source§

fn from(value: AnsiColor) -> Self

Converts to this type from the input type.
Source§

impl From<AnsiColor> for u8

Source§

fn from(value: AnsiColor) -> u8

Converts to this type from the input type.
Source§

impl Hash for AnsiColor

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

Source§

type Output = Color

The returned type after indexing.
Source§

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

Performs the indexing (container[index]) operation. Read more
Source§

impl IndexMut<AnsiColor> for Theme

Source§

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

Performs the mutable indexing (container[index]) operation. Read more
Source§

impl IntoPy<Py<PyAny>> for AnsiColor

Source§

fn into_py(self, py: Python<'_>) -> PyObject

👎Deprecated since 0.23.0: IntoPy is going to be replaced by IntoPyObject. See the migration guide (https://pyo3.rs/v0.23.0/migration) for more information.
Performs the conversion.
Source§

impl<'py> IntoPyObject<'py> for AnsiColor

Source§

type Target = AnsiColor

The Python output type
Source§

type Output = Bound<'py, <AnsiColor as IntoPyObject<'py>>::Target>

The smart pointer type to use. Read more
Source§

type Error = PyErr

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

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.
Source§

impl Ord for AnsiColor

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for AnsiColor

Source§

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

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl PyClass for AnsiColor

Source§

type Frozen = True

Whether the pyclass is frozen. Read more
Source§

impl PyClassImpl for AnsiColor

Source§

const IS_BASETYPE: bool = false

#[pyclass(subclass)]
Source§

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]
Source§

const IS_MAPPING: bool = false

#[pyclass(mapping)]
Source§

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]
Source§

type BaseType = PyAny

Base class
Source§

type ThreadChecker = SendablePyClass<AnsiColor>

This handles following two situations: Read more
Source§

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::ImmutableChild

Immutable or mutable
Source§

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.
Source§

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.
Source§

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.
Source§

fn items_iter() -> PyClassItemsIter

Source§

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc
Source§

fn lazy_type_object() -> &'static LazyTypeObject<Self>

§

fn dict_offset() -> Option<isize>

§

fn weaklist_offset() -> Option<isize>

Source§

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a AnsiColor

Source§

type Holder = Option<PyRef<'py, AnsiColor>>

Source§

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

Source§

impl PyMethods<AnsiColor> for PyClassImplCollector<AnsiColor>

Source§

fn py_methods(self) -> &'static PyClassItems

Source§

impl PyTypeInfo for AnsiColor

Source§

const NAME: &'static str = "AnsiColor"

Class name.
Source§

const MODULE: Option<&'static str>

Module name, if any.
Source§

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.
§

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.
§

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object
Deprecated name for [PyTypeInfo::type_object].
§

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.
§

fn is_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of
Deprecated name for [PyTypeInfo::is_type_of].
§

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.
§

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of
Deprecated name for [PyTypeInfo::is_exact_type_of].
Source§

impl TryFrom<u8> for AnsiColor

Source§

type Error = OutOfBoundsError

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

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

Performs the conversion.
Source§

impl Copy for AnsiColor

Source§

impl Eq for AnsiColor

Source§

impl HasCustomRichCmp for AnsiColor

Source§

impl StructuralPartialEq for AnsiColor

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, dst: *mut u8)

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromPyObject<'_> for T
where T: PyClass + Clone,

§

fn extract_bound(obj: &Bound<'_, PyAny>) -> Result<T, PyErr>

Extracts Self from the bound smart pointer obj. Read more
§

impl<'py, T> FromPyObjectBound<'_, 'py> for T
where T: FromPyObject<'py>,

§

fn from_py_object_bound(ob: Borrowed<'_, 'py, PyAny>) -> Result<T, PyErr>

Extracts Self from the bound smart pointer obj. 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.

§

impl<'py, T> IntoPyObjectExt<'py> for T
where T: IntoPyObject<'py>,

§

fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>

Converts self into an owned Python object, dropping type information.
§

fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>

Converts self into an owned Python object, dropping type information and unbinding it from the 'py lifetime.
§

fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>

Converts self into a Python object. Read more
§

impl<T> PyErrArguments for T
where T: for<'py> IntoPyObject<'py> + Send + Sync,

§

fn arguments(self, py: Python<'_>) -> Py<PyAny>

Arguments for exception
§

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

§

const NAME: &'static str = <T as PyTypeInfo>::NAME

Name of self. This is used in error messages, for example.
§

fn type_check(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of Self, which may include a subtype. Read more
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.
§

impl<T> Ungil for T
where T: Send,