Enum TriState

#[repr(u8)]
pub enum TriState {
    NotAvailable = 126,
    No = 78,
    Yes = 89,
}

An enum for representing unknown, true, or false values. Equivalent to Option<bool> but with a human-readable repr.

Variants

NotAvailable = 126

The value is not applicable or not known.

No = 78

False

Yes = 89

True

Trait Implementations

impl Clone for TriState

fn clone(&self) -> TriState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TriState

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

Formats the value using the given formatter.

impl Default for TriState

fn default() -> TriState

Returns the “default value” for a type.

impl From<Option<bool>> for TriState

fn from(value: Option<bool>) -> Self

Converts to this type from the input type.

impl From<TriState> for Option<bool>

fn from(value: TriState) -> Self

Converts to this type from the input type.

impl From<TriState> for u8

fn from(enum_value: TriState) -> Self

Converts to this type from the input type.

impl Hash for TriState

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 IntoEnumIterator for TriState

type Iterator = TriStateIter

fn iter() -> TriStateIter

impl<'py> IntoPyObject<'py> for TriState

type Target = TriState

The Python output type

type Output = Bound<'py, <TriState 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 Ord for TriState

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TriState

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

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl PyClass for TriState

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for TriState

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

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<TriState>

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<TriState> for PyClassImplCollector<TriState>

Available on crate feature python only.

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

impl PyClass__eq__SlotFragment<TriState> for PyClassImplCollector<TriState>

Available on crate feature python only.

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

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

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a TriState

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

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

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

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

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

impl PyMethods<TriState> for PyClassImplCollector<TriState>

Available on crate feature python only.

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for TriState

const NAME: &'static str = "TriState"

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 TryFrom<u8> for TriState

type Error = TryFromPrimitiveError<TriState>

The type returned in the event of a conversion error.

fn try_from(number: u8) -> Result<Self, TryFromPrimitiveError<Self>>

Performs the conversion.

impl TryFromPrimitive for TriState

const NAME: &'static str = "TriState"

type Primitive = u8

type Error = TryFromPrimitiveError<TriState>

fn try_from_primitive( number: Self::Primitive, ) -> Result<Self, TryFromPrimitiveError<Self>>

impl Copy for TriState

impl Eq for TriState

impl StructuralPartialEq for TriState