Enum LogFormat 

#[repr(C)]
pub enum LogFormat {
    Header = 0,
    Endc = 1,
    Bold = 2,
    Underline = 3,
}

An ANSI log line format specifier. This is used for formatting log messages with ANSI escape codes.

Variants

Header = 0

Header log format. This ANSI escape code is used for magenta text color, often used for headers or titles in the log output.

Endc = 1

Endc log format. This ANSI escape code is used to reset all format attributes to their defaults. It should be used after applying other formats.

Bold = 2

Bold log format. This ANSI escape code is used to make the text bold in the log output.

Underline = 3

Underline log format. This ANSI escape code is used to underline the text in the log output.

Implementations

impl LogFormat

pub const fn from_repr(discriminant: usize) -> Option<LogFormat>

Try to create Self from the raw representation

Trait Implementations

impl Clone for LogFormat

fn clone(&self) -> LogFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LogFormat

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

Formats the value using the given formatter.

impl Display for LogFormat

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

Formats the value using the given formatter.

impl<'a, 'py> FromPyObject<'a, 'py> for LogFormat

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl FromStr for LogFormat

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<LogFormat, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for LogFormat

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'py> IntoPyObject<'py> for LogFormat

type Target = LogFormat

The Python output type

type Output = Bound<'py, <LogFormat 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<'py>>::Output, <Self as IntoPyObject<'py>>::Error>

Performs the conversion.

impl PartialEq for LogFormat

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

const NAME: &str = "LogFormat"

Name of the class.

type Frozen = True

Whether the pyclass is frozen.

impl PyClassImpl for LogFormat

const MODULE: Option<&str>

Module which the class will be associated with.

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 = /// An ANSI log line format specifier. /// This is used for formatting log messages with ANSI escape codes.

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 Layout = <<LogFormat as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<LogFormat>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForLogFormat

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

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<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyStubType for LogFormat

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for LogFormat

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

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 TryFrom<&str> for LogFormat

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<LogFormat, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl Copy for LogFormat

impl Eq for LogFormat

impl StructuralPartialEq for LogFormat