Struct Theme

pub struct Theme { /* private fields */ }

A color theme.

A color theme is a container with ThemeEntry::COUNT colors, one each for the 16 ANSI colors as well as the default foreground and background colors (in that order). The public interface is a compromise between struct and array, a straurray if you will, to make the primary use case, processing the colors in a theme, safer than when using numeric indices. Hence, you index a color theme with semantic values, i.e., ThemeEntry, Layer, or AnsiColor. At the same time, you can still access the underlying array storage through AsRef<[Color]> for Theme, albeit Rust-only and read-only.

Implementations

impl Theme

pub fn new() -> Self

Create a new color theme with ThemeEntry::COUNT times the default color.

pub const fn with_array(colors: [Color; 18]) -> Self

Create a new color theme with the given colors.

pub fn with_slice(colors: &[Color]) -> Option<Self>

Create a new color theme with the given colors.

The given slice must have length ThemeEntry::COUNT. Otherwise, this method returns None.

impl Theme

pub const fn py_with_array(inner: [Color; 18]) -> Self

Create a new color theme with the given colors.

pub fn __getitem__(&self, index: ThemeEntry) -> Color

Get the color for the given theme entry.

pub fn __setitem__(&mut self, index: ThemeEntry, value: Color)

Set the color for the given theme entry.

pub fn __repr__(&self) -> String

impl Theme

pub fn query(connection: &Connection) -> Result<Self>

Query the terminal for the current color theme. TTY only!

Trait Implementations

impl AsRef<[Color]> for Theme

fn as_ref(&self) -> &[Color]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Theme

fn clone(&self) -> Theme

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Theme

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

Formats the value using the given formatter.

impl Default for Theme

fn default() -> Self

Returns the “default value” for a type.

impl Index<AnsiColor> for Theme

type Output = Color

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<Layer> for Theme

type Output = Color

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

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

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

Performs the mutable 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<'py> IntoPyObject<'py> for Theme

type Target = Theme

The Python output type

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

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

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

Performs the conversion.

impl PartialEq for Theme

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Theme

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = c"A color theme.\n\nA color theme is a container with [`ThemeEntry::COUNT`] colors, one each for\nthe 16 ANSI colors as well as the default foreground and background colors\n(in that order). The public interface is a compromise between struct and\narray, a straurray if you will, to make the primary use case, processing the\ncolors in a theme, safer than when using numeric indices. Hence, you index a\ncolor theme with semantic values, i.e., [`ThemeEntry`], [`Layer`], or\n[`AnsiColor`]. At the same time, you can still access the underlying array\nstorage through [`AsRef<[Color]> for\nTheme`](struct.Theme.html#impl-AsRef%3C%5BColor%5D%3E-for-Theme), albeit\nRust-only and read-only.\x00"

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<Theme>

This handles following two situations:

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

Immutable or mutable

type Dict = PyClassDummySlot

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

type WeakRef = PyClassDummySlot

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

type BaseNativeType = PyAny

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

fn items_iter() -> PyClassItemsIter

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

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for Theme

const TEXT_SIGNATURE: &'static str = "(inner)"

impl PyClass__setitem__SlotFragment<Theme> for PyClassImplCollector<Theme>

unsafe fn __setitem__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, arg1: NonNull<PyObject>, ) -> PyResult<()>

Safety: _slf and _attr must be valid non-null Python objects

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder Theme

type Holder = Option<PyClassGuard<'a, Theme>>

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

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder mut Theme

type Holder = Option<PyClassGuardMut<'a, Theme>>

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

impl PyMethods<Theme> for PyClassImplCollector<Theme>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Theme

const NAME: &'static str = "Theme"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

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 is_type_of(object: &Bound<'_, PyAny>) -> bool

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

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

Checks if object is an instance of this type.

impl DerefToPyAny for Theme

impl Eq for Theme

impl StructuralPartialEq for Theme