Struct swim_structure::item::Num

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

Value variant representing a number.

Methods

impl<'a> Num<'a>

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

Constructs a new Num from a u8 value.

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

Constructs a new Num from an i8 value.

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

Constructs a new Num from a u16 value.

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

Constructs a new Num from an i16 value.

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

Constructs a new Num from a u32 value.

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

Constructs a new Num from an i32 value.

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

Constructs a new Num from a u64 value.

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

Constructs a new Num from an i64 value.

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

Constructs a new Num from an f16 value.

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

Constructs a new Num from an f32 value.

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

Constructs a new Num from an f64 value.

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

Constructs a new Num from a usize value.

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

Constructs a new Num from an isize value.

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

Upcasts this Num reference to a Value reference.

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

Upcasts this Num reference to a mutable Value reference.

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

Upcasts this Num to a Value.

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

Upcasts this Num to an Item.

pub fn is_u8(&self) -> bool

Returns true if this Num was created from a u8 value.

pub fn is_i8(&self) -> bool

Returns true if this Num was created from an i8 value.

pub fn is_u16(&self) -> bool

Returns true if this Num was created from a u16 value.

pub fn is_i16(&self) -> bool

Returns true if this Num was created from an i16 value.

pub fn is_u32(&self) -> bool

Returns true if this Num was created from a u32 value.

pub fn is_i32(&self) -> bool

Returns true if this Num was created from an i32 value.

pub fn is_u64(&self) -> bool

Returns true if this Num was created from a u64 value.

pub fn is_i64(&self) -> bool

Returns true if this Num was created from an i64 value.

pub fn is_f16(&self) -> bool

Returns true if this Num was created from an f16 value.

pub fn is_f32(&self) -> bool

Returns true if this Num was created from an f32 value.

pub fn is_f64(&self) -> bool

Returns true if this Num was created from an f64 value.

pub fn is_big_int(&self) -> bool

Returns true if this Num was created from a big integer.

pub fn is_big_dec(&self) -> bool

Returns true if this Num was created from a big decimal.

pub fn is_usize(&self) -> bool

Returns true if this Num was created from a usize value.

pub fn is_isize(&self) -> bool

Returns true if this Num was created from an isize value.

pub fn is_valid_u8(&self) -> bool

Returns true if this Num can losslessly convert to a u8 value.

pub fn is_valid_i8(&self) -> bool

Returns true if this Num can losslessly convert to an i8 value.

pub fn is_valid_u16(&self) -> bool

Returns true if this Num can losslessly convert to a u16 value.

pub fn is_valid_i16(&self) -> bool

Returns true if this Num can losslessly convert to an i16 value.

pub fn is_valid_u32(&self) -> bool

Returns true if this Num can losslessly convert to a u32 value.

pub fn is_valid_i32(&self) -> bool

Returns true if this Num can losslessly convert to an i32 value.

pub fn is_valid_u64(&self) -> bool

Returns true if this Num can losslessly convert to a u64 value.

pub fn is_valid_i64(&self) -> bool

Returns true if this Num can losslessly convert to an i64 value.

pub fn is_valid_f16(&self) -> bool

Returns true if this Num can losslessly convert to an f16 value.

pub fn is_valid_f32(&self) -> bool

Returns true if this Num can losslessly convert to an f32 value.

pub fn is_valid_f64(&self) -> bool

Returns true if this Num can losslessly convert to an f64 value.

pub fn is_valid_big_int(&self) -> bool

Returns true if this Num can losslessly convert to a big integer.

pub fn is_valid_big_dec(&self) -> bool

Returns true if this Num can losslessly convert to a big decimal.

pub fn is_valid_usize(&self) -> bool

Returns true if this Num can losslessly convert to a usize value.

pub fn is_valid_isize(&self) -> bool

Returns true if this Num can losslessly convert to an isize value.

pub fn as_u8(&self) -> u8

Coerces this Num to a u8 value.

pub fn as_i8(&self) -> i8

Coerces this Num to an i8 value.

pub fn as_u16(&self) -> u16

Coerces this Num to a u16 value.

pub fn as_i16(&self) -> i16

Coerces this Num to an i16 value.

pub fn as_u32(&self) -> u32

Coerces this Num to a u32 value.

pub fn as_i32(&self) -> i32

Coerces this Num to an i32 value.

pub fn as_u64(&self) -> u64

Coerces this Num to a u64 value.

pub fn as_i64(&self) -> i64

Coerces this Num to an i64 value.

pub fn as_f16(&self) -> f16

Coerces this Num to an f16 value.

pub fn as_f32(&self) -> f32

Coerces this Num to an f32 value.

pub fn as_f64(&self) -> f64

Coerces this Num to an f64 value.

pub fn as_usize(&self) -> usize

Coerces this Num to a usize value.

pub fn as_isize(&self) -> isize

Coerces this Num to an isize value.

pub fn to_u8(&self) -> Option<u8>

Losslessly converts this Num to a u8 value, if possible.

pub fn to_i8(&self) -> Option<i8>

Losslessly converts this Num to an i8 value, if possible.

pub fn to_u16(&self) -> Option<u16>

Losslessly converts this Num to a u16 value, if possible.

pub fn to_i16(&self) -> Option<i16>

Losslessly converts this Num to an i16 value, if possible.

pub fn to_u32(&self) -> Option<u32>

Losslessly converts this Num to a u32 value, if possible.

pub fn to_i32(&self) -> Option<i32>

Losslessly converts this Num to an i32 value, if possible.

pub fn to_u64(&self) -> Option<u64>

Losslessly converts this Num to a u64 value, if possible.

pub fn to_i64(&self) -> Option<i64>

Losslessly converts this Num to an i64 value, if possible.

pub fn to_f16(&self) -> Option<f16>

Losslessly converts this Num to an f16 value, if possible.

pub fn to_f32(&self) -> Option<f32>

Losslessly converts this Num to an f32 value, if possible.

pub fn to_f64(&self) -> Option<f64>

Losslessly converts this Num to an f64 value, if possible.

pub fn to_usize(&self) -> Option<usize>

Losslessly converts this Num to a usize value, if possible.

pub fn to_isize(&self) -> Option<isize>

Losslessly converts this Num to an isize value, if possible.

Trait Implementations

impl<'a> PartialEq<Num<'a>> for Num<'a>

fn eq(&self, that: &Num<'a>) -> 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<'a> Eq for Num<'a>

impl<'a> Ord for Num<'a>

fn cmp(&self, that: &Num<'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<Num<'a>> for Num<'a>

fn partial_cmp(&self, that: &Num<'a>) -> Option<Ordering>

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

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

fn from(num: Num<'a>) -> Item<'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<u8> for Num<'a>

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<'a> Debug for Num<'a>

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

Formats the value using the given formatter.

impl<'a> Drop for Num<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> Hash for Num<'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 Num<'a>

fn clone(&self) -> Num<'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 Num<'a>

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

Performs the conversion.

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

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

Performs the conversion.

impl<'a> Default for Num<'a>

fn default() -> Num<'a>

Returns the "default value" for a type.

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

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

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

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

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

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