Struct prettypretty::style::Stylist

pub struct Stylist { /* private fields */ }

A stylist is a builder of styles.

Implementations

impl Stylist

pub fn py_new() -> Self

Create a new style builder.

pub fn py_with_reset() -> Self

Create a new style builder that has a reset token as first token.

pub fn py_bold(slf: PyRef<'_, Self>) -> PyRef<'_, Self>

Add bold formatting to this style builder.

pub fn py_thin(slf: PyRef<'_, Self>) -> PyRef<'_, Self>

Add thin formatting to this style builder.

pub fn py_italic(slf: PyRef<'_, Self>) -> PyRef<'_, Self>

Add italic formatting to this style builder.

pub fn py_underlined(slf: PyRef<'_, Self>) -> PyRef<'_, Self>

Add underlined formatting to this style builder.

pub fn py_blinking(slf: PyRef<'_, Self>) -> PyRef<'_, Self>

Add blinking formatting to this style builder.

pub fn py_reversed(slf: PyRef<'_, Self>) -> PyRef<'_, Self>

Add reversed formatting to this style builder.

pub fn py_hidden(slf: PyRef<'_, Self>) -> PyRef<'_, Self>

Add hidden formatting to this style builder.

pub fn py_stricken(slf: PyRef<'_, Self>) -> PyRef<'_, Self>

Add stricken formatting to this style builder.

pub fn py_foreground( slf: PyRef<'_, Self>, colorant: Colorant, ) -> PyRef<'_, Self>

Push a foreground color onto this style builder.

pub fn py_background( slf: PyRef<'_, Self>, colorant: Colorant, ) -> PyRef<'_, Self>

Push a background color onto this style builder.

pub fn et_voila(&self) -> Style

Finish building and return a new style.

This method moves the builder’s data into the new style and leaves an empty builder behind.

pub fn build(&self) -> Style

Finish building and return a new style.

This method moves the builder’s data into the new style and leaves an empty builder behind. Consider using Stylist::et_voila instead.

pub fn __repr__(&self) -> String

Render a debug representation of this stylist. Python only!

impl Stylist

pub const fn new() -> Self

Create a new style builder.

pub fn with_reset() -> Self

Create a new style builder for a style that resets the terminal appearance.

pub fn bold(&self) -> &Self

Add bold formatting to this style builder.

pub fn thin(&self) -> &Self

Add thin formatting to this style builder.

pub fn italic(&self) -> &Self

Add italic formatting to this style builder.

pub fn underlined(&self) -> &Self

Add underlined formatting to this style builder.

pub fn blinking(&self) -> &Self

Add blinking formatting to this style builder.

pub fn reversed(&self) -> &Self

Add reversed formatting to this style builder.

pub fn hidden(&self) -> &Self

Add hidden formatting to this style builder.

pub fn stricken(&self) -> &Self

Add stricken formatting to this style builder.

pub fn foreground(&self, color: impl Into<Colorant>) -> &Self

Add a foreground color to this style builder.

pub fn background(&self, color: impl Into<Colorant>) -> &Self

Add a background color to this style builder.

Trait Implementations

impl Clone for Stylist

fn clone(&self) -> Stylist

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Stylist

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

Formats the value using the given formatter.

impl Default for Stylist

fn default() -> Stylist

Returns the “default value” for a type.

impl IntoPy<Py<PyAny>> for Stylist

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

Performs the conversion.

impl PyClass for Stylist

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Stylist

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)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<Stylist>

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 doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

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

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<Stylist> for PyClassImplCollector<Stylist>

fn new_text_signature(self) -> Option<&'static str>

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

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

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

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut Stylist

type Holder = Option<PyRefMut<'py, Stylist>>

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

impl PyMethods<Stylist> for PyClassImplCollector<Stylist>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Stylist

const NAME: &'static str = "Stylist"

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_bound(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

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

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

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

Checks if object is an instance of this type.

impl DerefToPyAny for Stylist