Struct Boolean

pub struct Boolean(pub bool);

Any value that can be interpreted as a boolean.

Tuple Fields

0: bool

Implementations

impl Boolean

pub fn is_true(self) -> bool

Return true if the boolean is a true value.

Note that the inner value is accessible directly as well.

Trait Implementations

impl Clone for Boolean

fn clone(&self) -> Boolean

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Boolean

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

Formats the value using the given formatter.

impl Default for Boolean

fn default() -> Boolean

Returns the “default value” for a type.

impl Display for Boolean

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

Formats the value using the given formatter.

impl From<Boolean> for bool

fn from(b: Boolean) -> Self

Converts to this type from the input type.

impl Hash for Boolean

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 Ord for Boolean

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

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

fn partial_cmp(&self, other: &Boolean) -> 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 Serialize for Boolean

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&BStr> for Boolean

Warning

The direct usage of try_from("string") is discouraged as it will produce the wrong result for values obtained from core.bool-implicit-true, which have no separator and are implicitly true. This method chooses to work correctly for core.bool-empty=, which is an empty string and resolves to being false.

Instead of this, obtain booleans with config.boolean(…), which handles the case were no separator is present correctly.

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Cow<'_, BStr>> for Boolean

type Error = Error

The type returned in the event of a conversion error.

fn try_from(c: Cow<'_, BStr>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<OsString> for Boolean

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Boolean

impl Eq for Boolean

impl StructuralPartialEq for Boolean