Struct Bool

pub struct Bool<const D: bool = false>(pub bool);

A bool wrapper type that serializes true and false to "yes" and "no" respectively. Bool is generic over its default value D.

See Bool::serialize and Bool::deserialize for how the default value D is used to serialize and deserialize empty/None values.

Examples

assert_eq!("yes", Bool::<false>::YES.as_str());
assert_eq!(Bool::<false>::NO, "no".parse().unwrap());
assert_eq!(Bool(true), Bool::<true>::default());

Tuple Fields

0: bool

Implementations

impl<const D: bool> Bool<D>

pub const YES: Self

Equivalent to true or "yes".

pub const NO: Self

Equivalent to false or "no“.

pub const fn yes() -> Self

Returns the Bool corresponding to "yes".

pub const fn no() -> Self

Returns the Bool corresponding to "no".

pub const fn as_str(&self) -> &'static str

Returns the string literal representation ("yes" or "no") for this boolean value.

Trait Implementations

impl<const D: bool> Clone for Bool<D>

fn clone(&self) -> Bool<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const D: bool> Debug for Bool<D>

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

Formats the value using the given formatter.

impl<const D: bool> Default for Bool<D>

fn default() -> Self

Uses the const generic parameter D as the default value and returns Bool(D).

impl<'de, const DEFAULT: bool> Deserialize<'de> for Bool<DEFAULT>

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserializes an empty value to Bool::<DEFAULT>::default(), otherwise deserializes from the string representation.

impl<const D: bool> Display for Bool<D>

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

Formats the value using the given formatter.

impl<const D: bool> From<Bool<D>> for &'static str

fn from(value: Bool<D>) -> Self

Converts to this type from the input type.

impl<const D: bool> From<Bool<D>> for bool

fn from(value: Bool<D>) -> Self

Converts to this type from the input type.

impl<const D: bool> From<bool> for Bool<D>

fn from(value: bool) -> Self

Converts to this type from the input type.

impl<const D: bool> FromStr for Bool<D>

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

Returns Bool(true) if "yes", Bool(false) if "no", otherwise returns Err.

type Err = &'static str

The associated error which can be returned from parsing.

impl<const D: bool> Ord for Bool<D>

fn cmp(&self, other: &Bool<D>) -> 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<const D: bool> PartialEq for Bool<D>

fn eq(&self, other: &Bool<D>) -> 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<const D: bool> PartialOrd for Bool<D>

fn partial_cmp(&self, other: &Bool<D>) -> 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<const D: bool> Serialize for Bool<D>

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

Serializes Bool::<D>::default() to None, otherwise serializes the string representation.

impl<const D: bool> TryFrom<&str> for Bool<D>

type Error = <Bool<D> as FromStr>::Err

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const D: bool> TryFrom<String> for Bool<D>

type Error = <Bool<D> as FromStr>::Err

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const D: bool> Copy for Bool<D>

impl<const D: bool> Eq for Bool<D>

impl<const D: bool> StructuralPartialEq for Bool<D>