Struct swim_structure::item::Value

#[repr(C)]
pub struct Value<'a> { /* fields omitted */ }

Item variant representing an unkeyed value.

Methods

impl<'a> Value<'a>

pub fn try_hold_str(
    hold: &dyn Hold<'a>,
    data: &str
) -> Result<Value<'a>, HoldError>

pub fn hold_str(hold: &dyn Hold<'a>, data: &str) -> Value<'a>

pub fn from_str(data: &str) -> Value<'a>

pub const fn from_u8(value: u8) -> Value<'a>

Constructs a new Value from a u8 value.

pub const fn from_i8(value: i8) -> Value<'a>

Constructs a new Value from an i8 value.

pub const fn from_u16(value: u16) -> Value<'a>

Constructs a new Value from a u16 value.

pub const fn from_i16(value: i16) -> Value<'a>

Constructs a new Value from an i16 value.

pub const fn from_u32(value: u32) -> Value<'a>

Constructs a new Value from a u32 value.

pub const fn from_i32(value: i32) -> Value<'a>

Constructs a new Value from an i32 value.

pub const fn from_u64(value: u64) -> Value<'a>

Constructs a new Value from a u64 value.

pub const fn from_i64(value: i64) -> Value<'a>

Constructs a new Value from an i64 value.

pub fn from_f16(value: f16) -> Value<'a>

Constructs a new Value from an f16 value.

pub fn from_f32(value: f32) -> Value<'a>

Constructs a new Value from an f32 value.

pub fn from_f64(value: f64) -> Value<'a>

Constructs a new Value from an f64 value.

pub const fn from_usize(value: usize) -> Value<'a>

Constructs a new Value from a usize value.

pub const fn from_isize(value: isize) -> Value<'a>

Constructs a new Value from an isize value.

pub const fn from_bool(value: bool) -> Value<'a>

Constructs a new Value from a bool value.

pub const fn extant() -> Value<'a>

Constructs a new extant Value.

pub const fn absent() -> Value<'a>

Constructs a new absent Value.

pub fn is_defined(&self) -> bool

Returns true if this Value is not Absent.

pub fn is_record(&self) -> bool

Returns true if this Value is a Record.

pub fn is_data(&self) -> bool

Returns true if this Value is Data.

pub fn is_text(&self) -> bool

Returns true if this Value is Text.

pub fn is_num(&self) -> bool

Returns true if this Value is a Num.

pub fn is_bool(&self) -> bool

Returns true if this Value is a Bool.

pub fn is_extant(&self) -> bool

Returns true if this Value is Extant.

pub fn is_absent(&self) -> bool

Returns true if this Value is Absent.

pub fn as_record(&self) -> &Record<'a>

Downcasts this Value reference to a Record reference.

Panics

Panics if this Value is not, in fact, a Record.

pub fn as_mut_record(&mut self) -> &mut Record<'a>

Downcasts this Value reference to a mutable Record reference.

Panics

Panics if this Value is not, in fact, a Record.

pub fn as_data(&self) -> &Data<'a>

Downcasts this Value reference to a Data reference.

Panics

Panics if this Value is not, in fact, Data.

pub fn as_mut_data(&mut self) -> &mut Data<'a>

Downcasts this Value reference to a mutable Data reference.

Panics

Panics if this Value is not, in fact, Data.

pub fn as_text(&self) -> &Text<'a>

Downcasts this Value reference to a Text reference.

Panics

Panics if this Value is not, in fact, Text.

pub fn as_mut_text(&mut self) -> &mut Text<'a>

Downcasts this Value reference to a mutable Text reference.

Panics

Panics if this Value is not, in fact, Text.

pub fn as_num(&self) -> &Num<'a>

Downcasts this Value reference to a Num reference.

Panics

Panics if this Value is not, in fact, a Num.

pub fn as_mut_num(&mut self) -> &mut Num<'a>

Downcasts this Value reference to a mutable Num reference.

Panics

Panics if this Value is not, in fact, a Num.

pub fn as_bool(&self) -> &Bool

Downcasts this Value reference to a Bool reference.

Panics

Panics if this Value is not, in fact, a Bool.

pub fn as_mut_bool(&mut self) -> &mut Bool

Downcasts this Value reference to a mutable Bool reference.

Panics

Panics if this Value is not, in fact, a Bool.

pub fn as_extant(&self) -> &Extant

Downcasts this Value reference to an Extant reference.

Panics

Panics if this Value is not, in fact, Extant.

pub fn as_absent(&self) -> &Absent

Downcasts this Value reference to an Absent reference.

Panics

Panics if this Value is not, in fact, Absent.

pub unsafe fn as_record_unchecked(&self) -> &Record<'a>

Reinterprets this Value reference as a Record reference.

Safety

Does not verify that this Value is, in fact, a Record.

pub unsafe fn as_mut_record_unchecked(&mut self) -> &mut Record<'a>

Reinterprets this Value reference as a mutable Record reference.

Safety

Does not verify that this Value is, in fact, a Record.

pub unsafe fn as_data_unchecked(&self) -> &Data<'a>

Reinterprets this Value reference as a Data reference.

Safety

Does not verify that this Value is, in fact, Data.

pub unsafe fn as_mut_data_unchecked(&mut self) -> &mut Data<'a>

Reinterprets this Value reference as a mutable Data reference.

Safety

Does not verify that this Value is, in fact, Data.

pub unsafe fn as_text_unchecked(&self) -> &Text<'a>

Reinterprets this Value reference as a Text reference.

Safety

Does not verify that this Value is, in fact, Text.

pub unsafe fn as_mut_text_unchecked(&mut self) -> &mut Text<'a>

Reinterprets this Value reference as a Text reference.

Safety

Does not verify that this Value is, in fact, Text.

pub unsafe fn as_num_unchecked(&self) -> &Num<'a>

Reinterprets this Value reference as a Num reference.

Safety

Does not verify that this Value is, in fact, a Num.

pub unsafe fn as_mut_num_unchecked(&mut self) -> &mut Num<'a>

Reinterprets this Value reference as a Num reference.

Safety

Does not verify that this Value is, in fact, a Num.

pub unsafe fn as_bool_unchecked(&self) -> &Bool

Reinterprets this Value reference as a Bool reference.

Safety

Does not verify that this Value is, in fact, a Bool.

pub unsafe fn as_mut_bool_unchecked(&mut self) -> &mut Bool

Reinterprets this Value reference as a Bool reference.

Safety

Does not verify that this Value is, in fact, a Bool.

pub unsafe fn as_extant_unchecked(&self) -> &Extant

Reinterprets this Value reference as an Extant reference.

Safety

Does not verify that this Value is, in fact, Extant.

pub unsafe fn as_mut_extant_unchecked(&mut self) -> &mut Extant

Reinterprets this Value reference as an Extant reference.

Safety

Does not verify that this Value is, in fact, Extant.

pub unsafe fn as_absent_unchecked(&self) -> &Absent

Reinterprets this Value reference as an Absent reference.

Safety

Does not verify that this Value is, in fact, Absent.

pub unsafe fn as_mut_absent_unchecked(&mut self) -> &mut Absent

Reinterprets this Value reference as an Absent reference.

Safety

Does not verify that this Value is, in fact, Absent.

pub fn into_record(self) -> Record<'a>

Downcasts this Value to a Record.

Panics

Panics if this Value is not, in fact, a Record.

pub fn into_data(self) -> Data<'a>

Downcasts this Value to Data.

Panics

Panics if this Value is not, in fact, Data.

pub fn into_text(self) -> Text<'a>

Downcasts this Value to Text.

Panics

Panics if this Value is not, in fact, Text.

pub fn into_num(self) -> Num<'a>

Downcasts this Value to a Num.

Panics

Panics if this Value is not, in fact, a Num.

pub fn into_bool(self) -> Bool

Downcasts this Value to a Bool.

Panics

Panics if this Value is not, in fact, a Bool.

pub fn into_extant(self) -> Extant

Downcasts this Value to Extant.

Panics

Panics if this Value is not, in fact, Extant.

pub fn into_absent(self) -> Absent

Downcasts this Value to Absent.

Panics

Panics if this Value is not, in fact, Absent.

pub unsafe fn into_record_unchecked(self) -> Record<'a>

Reinterprets this Value as a Record.

Safety

Does not verify that this Value is, in fact, a Record.

pub unsafe fn into_data_unchecked(self) -> Data<'a>

Reinterprets this Value as Data.

Safety

Does not verify that this Value is, in fact, Data.

pub unsafe fn into_text_unchecked(self) -> Text<'a>

Reinterprets this Value as Text.

Safety

Does not verify that this Value is, in fact, Text.

pub unsafe fn into_num_unchecked(self) -> Num<'a>

Reinterprets this Value as a Num.

Safety

Does not verify that this Value is, in fact, a Num.

pub unsafe fn into_bool_unchecked(self) -> Bool

Reinterprets this Value as a Bool.

Safety

Does not verify that this Value is, in fact, a Bool.

pub unsafe fn into_extant_unchecked(self) -> Extant

Reinterprets this Value as Extant.

Safety

Does not verify that this Value is, in fact, Extant.

pub unsafe fn into_absent_unchecked(self) -> Absent

Reinterprets this Value as Absent.

Safety

Does not verify that this Value is, in fact, Absent.

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

Upcasts this Value to an Item.

pub fn cast_as_record(&self) -> Option<&Record<'a>>

Downcasts this Value reference to a typechecked Record reference.

pub fn cast_as_mut_record(&mut self) -> Option<&mut Record<'a>>

Downcasts this Value reference to a typechecked, mutable Record reference.

pub fn cast_as_data(&self) -> Option<&Data<'a>>

Downcasts this Value reference to a typechecked Data reference.

pub fn cast_as_mut_data(&mut self) -> Option<&mut Data<'a>>

Downcasts this Value reference to a typechecked, mutable Data reference.

pub fn cast_as_text(&self) -> Option<&Text<'a>>

Downcasts this Value reference to a typechecked Text reference.

pub fn cast_as_mut_text(&mut self) -> Option<&mut Text<'a>>

Downcasts this Value reference to a typechecked, mutable Text reference.

pub fn cast_as_num(&self) -> Option<&Num<'a>>

Downcasts this Value reference to a typechecked Num reference.

pub fn cast_as_mut_num(&mut self) -> Option<&mut Num<'a>>

Downcasts this Value reference to a typechecked, mutable Num reference.

pub fn cast_as_bool(&self) -> Option<&Bool>

Downcasts this Value reference to a typechecked Bool reference.

pub fn cast_as_mut_bool(&mut self) -> Option<&mut Bool>

Downcasts this Value reference to a typechecked, mutable Bool reference.

pub fn cast_as_extant(&self) -> Option<&Extant>

Downcasts this Value reference to a typechecked Extant reference.

pub fn cast_as_absent(&self) -> Option<&Absent>

Downcasts this Value reference to a typechecked Absent reference.

pub fn cast_into_record(self) -> Option<Record<'a>>

Downcasts this Value to a typechecked Record.

pub fn cast_into_data(self) -> Option<Data<'a>>

Downcasts this Value to typechecked Data.

pub fn cast_into_text(self) -> Option<Text<'a>>

Downcasts this Value to typechecked Text.

pub fn cast_into_num(self) -> Option<Num<'a>>

Downcasts this Value to a typechecked Num.

pub fn cast_into_bool(self) -> Option<Bool>

Downcasts this Value to a typechecked Bool.

pub fn cast_into_extant(self) -> Option<Extant>

Downcasts this Value to typechecked Extant.

pub fn cast_into_absent(self) -> Option<Absent>

Downcasts this Value to typechecked Absent.

Trait Implementations

impl<'a> PartialEq<Value<'a>> for Value<'a>

fn eq(&self, that: &Value<'a>) -> bool

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

fn ne(&self, that: &Value<'a>) -> bool

This method tests for !=.

impl<'a> Eq for Value<'a>

impl<'a> Ord for Value<'a>

fn cmp(&self, other: &Value<'a>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'a> PartialOrd<Value<'a>> for Value<'a>

fn partial_cmp(&self, _that: &Value<'a>) -> Option<Ordering>

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

fn lt(&self, _that: &Value<'a>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, _that: &Value<'a>) -> bool

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

fn ge(&self, _that: &Value<'a>) -> bool

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

fn gt(&self, _that: &Value<'a>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

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

fn from(value: Value<'a>) -> Item<'a>

Performs the conversion.

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

fn from(record: Record<'a>) -> Value<'a>

Performs the conversion.

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

fn from(data: Data<'a>) -> Value<'a>

Performs the conversion.

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

fn from(text: Text<'a>) -> Value<'a>

Performs the conversion.

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

fn from(num: Num<'a>) -> Value<'a>

Performs the conversion.

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

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

Performs the conversion.

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

fn from(extant: Extant) -> Value<'a>

Performs the conversion.

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

fn from(absent: Absent) -> Value<'a>

Performs the conversion.

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

fn from(value: u8) -> Value<'a>

Performs the conversion.

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

fn from(value: i8) -> Value<'a>

Performs the conversion.

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

fn from(value: u16) -> Value<'a>

Performs the conversion.

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

fn from(value: i16) -> Value<'a>

Performs the conversion.

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

fn from(value: u32) -> Value<'a>

Performs the conversion.

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

fn from(value: i32) -> Value<'a>

Performs the conversion.

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

fn from(value: u64) -> Value<'a>

Performs the conversion.

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

fn from(value: i64) -> Value<'a>

Performs the conversion.

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

fn from(value: f16) -> Value<'a>

Performs the conversion.

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

fn from(value: f32) -> Value<'a>

Performs the conversion.

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

fn from(value: f64) -> Value<'a>

Performs the conversion.

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

fn from(value: usize) -> Value<'a>

Performs the conversion.

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

fn from(value: isize) -> Value<'a>

Performs the conversion.

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

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

Performs the conversion.

impl<'a> Debug for Value<'a>

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

Formats the value using the given formatter.

impl<'a> Drop for Value<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> Hash for Value<'a>

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<'a> Clone for Value<'a>

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

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 Record<'a>

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<'a> Default for Value<'a>

fn default() -> Value<'a>

Returns the "default value" for a type.

impl<'a, 'b> Stow<'b, Value<'b>> for Value<'a>

unsafe fn stow(
    src: *mut Value<'a>,
    dst: *mut Value<'b>,
    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 Value<'a>, dst: *mut Value<'b>)

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<'a> TryClone for Value<'a>

fn try_clone(&self) -> Result<Value<'a>, HoldError>

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

impl<'a, 'b> CloneIntoHold<'a, Value<'a>> for Value<'b>

fn try_clone_into_hold(
    &self,
    hold: &dyn Hold<'a>
) -> Result<Value<'a>, 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.