Struct swim_structure::item::Bool

#[repr(C)]
pub struct Bool { /* fields omitted */ }

Value variant representing a boolean.

Examples

Convert a primitive bool into a structurally typed Bool value:

let value = Bool::from(true);

Extract a primitive bool out of a structurally typed Bool value:

let value = Bool::from(false);
let primitive = value.to_bool();

Methods

impl Bool

pub const fn from_bool(value: bool) -> Bool

Constructs a new Bool from a bool value.

pub fn to_bool(&self) -> bool

Returns the bool value of this Bool reference.

pub fn as_value<'a>(&self) -> &Value<'a>

Upcasts this Bool reference to a Value reference.

pub fn as_mut_value<'a>(&mut self) -> &mut Value<'a>

Upcasts this Bool reference to a mutable Value reference.

pub fn into_value<'a>(self) -> Value<'a>

Upcasts this Bool to a Value.

pub fn into_item<'a>(self) -> Item<'a>

Upcasts this Bool to an Item.

Trait Implementations

impl PartialEq<Bool> for Bool

fn eq(&self, that: &Bool) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl Eq for Bool

impl<'a> From<Bool> for Item<'a>

fn from(bool: Bool) -> Item<'a>

Performs the conversion.

impl<'a> From<Bool> for Value<'a>

fn from(bool: Bool) -> Value<'a>

Performs the conversion.

impl From<bool> for Bool

fn from(value: bool) -> Bool

Performs the conversion.

impl From<Bool> for bool

fn from(value: Bool) -> bool

Performs the conversion.

impl Debug for Bool

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

Formats the value using the given formatter.

impl Hash for Bool

fn hash<H: Hasher>(&self, hasher: &mut H)

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Clone for Bool

fn clone(&self) -> Bool

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> AsMut<Value<'a>> for Bool

fn as_mut(&mut self) -> &mut Value<'a>

Performs the conversion.

impl<'a> AsRef<Value<'a>> for Bool

fn as_ref(&self) -> &Value<'a>

Performs the conversion.

impl Default for Bool

fn default() -> Bool

Returns the "default value" for a type.

impl<'b> Stow<'b, Bool> for Bool

unsafe fn stow(
    src: *mut Bool,
    dst: *mut Bool,
    _hold: &dyn Hold<'b>
) -> Result<(), HoldError>

Moves the value at the src pointer to the dst pointer, recursively moving all child values into the hold. If a child stow operation fails, then any already completed child stow operations get reverted by calling unstow on the child.

unsafe fn unstow(_src: *mut Bool, _dst: *mut Bool)

Reverts the most recent stow operation by moving the value at the dst pointer back to the src pointer from whence it came. The memory at the src address will be in the same state the stow operation left it in.

impl TryClone for Bool

fn try_clone(&self) -> Result<Bool, HoldError>

Returns a clone of self; returns an error if the clone fails.

impl<'a> CloneIntoHold<'a, Bool> for Bool

fn try_clone_into_hold(&self, _hold: &dyn Hold<'a>) -> Result<Bool, HoldError>

Returns a clone of self allocated in hold; returns an error if the clone fails.

default fn clone_into_hold(&self, hold: &dyn Hold<'a>) -> T

Returns a clone of self allocated in hold.