Skip to main content

Num

Enum Num 

Source
pub enum Num {
Show 14 variants U8(u8), U16(u16), U32(u32), U64(u64), U128(u128), USize(usize), I8(i8), I16(i16), I32(i32), I64(i64), I128(i128), ISize(isize), F32(f32), F64(f64),
}
Expand description

A signed or unsigned numeric value.

Variants§

§

U8(u8)

An 8-bit unsigned integer.

§

U16(u16)

A 16-bit unsigned integer.

§

U32(u32)

A 32-bit unsigned integer.

§

U64(u64)

A 64-bit unsigned integer.

§

U128(u128)

A 128-bit unsigned integer.

§

USize(usize)

An unsigned integer of platform width.

§

I8(i8)

An 8-bit signed integer.

§

I16(i16)

A 16-bit signed integer.

§

I32(i32)

A 32-bit signed integer.

§

I64(i64)

A 64-bit signed integer.

§

I128(i128)

A 128-bit signed integer.

§

ISize(isize)

A signed integer of platform width.

§

F32(f32)

A 32-bit wide float.

§

F64(f64)

A 64-bit wide float.

Implementations§

Source§

impl Num

Source

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

Converts self into a u32 if self is an unsigned variant with <= 32 bits.

§Example
use figment::value::Num;

let num: Num = 123u8.into();
assert_eq!(num.to_u32(), Some(123));

let num: Num = (u32::max_value() as u64 + 1).into();
assert_eq!(num.to_u32(), None);
Source

pub fn to_u128(self) -> Option<u128>

Converts self into a u128 if self is an unsigned variant.

§Example
use figment::value::Num;

let num: Num = 123u8.into();
assert_eq!(num.to_u128(), Some(123));
Source

pub fn to_u128_lossy(self) -> Option<u128>

Converts self into a u128 if it is non-negative, even if self is of a signed variant.

§Example
use figment::value::Num;

let num: Num = 123u8.into();
assert_eq!(num.to_u128_lossy(), Some(123));

let num: Num = 123i8.into();
assert_eq!(num.to_u128_lossy(), Some(123));
Source

pub fn to_i128(self) -> Option<i128>

Converts self into an i128 if self is a signed Value::Num variant.

§Example
use figment::value::Num;

let num: Num = 123i8.into();
assert_eq!(num.to_i128(), Some(123));
Source

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

Converts self into an f64 if self is either a Num::F32 or Num::F64.

§Example
use figment::value::Num;

let num: Num = 3.0f32.into();
assert_eq!(num.to_f64(), Some(3.0f64));
Source

pub fn to_actual(&self) -> Actual

Converts self into an Actual. All unsigned variants return Actual::Unsigned, signed variants Actual::Signed, and float variants Actual::Float. Values exceeding the bit-width of the target Actual are truncated.

§Example
use figment::{value::Num, error::Actual};

assert_eq!(Num::U8(10).to_actual(), Actual::Unsigned(10));
assert_eq!(Num::U64(2380).to_actual(), Actual::Unsigned(2380));

assert_eq!(Num::I8(127).to_actual(), Actual::Signed(127));
assert_eq!(Num::ISize(23923).to_actual(), Actual::Signed(23923));

assert_eq!(Num::F32(2.5).to_actual(), Actual::Float(2.5));
assert_eq!(Num::F64(2.103).to_actual(), Actual::Float(2.103));

Trait Implementations§

Source§

impl Clone for Num

Source§

fn clone(&self) -> Num

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Num

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserializer<'de> for Num

Source§

type Error = Error

The error type that can be returned if some error occurs during deserialization.
Source§

fn deserialize_any<V>(self, visitor: V) -> Result<V::Value>
where V: Visitor<'de>,

Require the Deserializer to figure out how to drive the visitor based on what data type is in the input. Read more
Source§

fn deserialize_bool<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting a bool value.
Source§

fn deserialize_u8<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u8 value.
Source§

fn deserialize_u16<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u16 value.
Source§

fn deserialize_u32<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u32 value.
Source§

fn deserialize_u64<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u64 value.
Source§

fn deserialize_i8<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i8 value.
Source§

fn deserialize_i16<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i16 value.
Source§

fn deserialize_i32<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i32 value.
Source§

fn deserialize_i64<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i64 value.
Source§

fn deserialize_f32<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting a f32 value.
Source§

fn deserialize_f64<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting a f64 value.
Source§

fn deserialize_char<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting a char value.
Source§

fn deserialize_str<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting a string value and does not benefit from taking ownership of buffered data owned by the Deserializer. Read more
Source§

fn deserialize_string<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting a string value and would benefit from taking ownership of buffered data owned by the Deserializer. Read more
Source§

fn deserialize_seq<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting a sequence of values.
Source§

fn deserialize_enum<V>( self, name: &'static str, variants: &'static [&'static str], visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting an enum value with a particular name and possible variants.
Source§

fn deserialize_bytes<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting a byte array and does not benefit from taking ownership of buffered data owned by the Deserializer. Read more
Source§

fn deserialize_byte_buf<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting a byte array and would benefit from taking ownership of buffered data owned by the Deserializer. Read more
Source§

fn deserialize_map<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting a map of key-value pairs.
Source§

fn deserialize_struct<V>( self, name: &'static str, fields: &'static [&'static str], visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting a struct with a particular name and fields.
Source§

fn deserialize_unit<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting a unit value.
Source§

fn deserialize_newtype_struct<V>( self, name: &'static str, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting a newtype struct with a particular name.
Source§

fn deserialize_ignored_any<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type needs to deserialize a value whose type doesn’t matter because it is ignored. Read more
Source§

fn deserialize_unit_struct<V>( self, name: &'static str, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting a unit struct with a particular name.
Source§

fn deserialize_tuple_struct<V>( self, name: &'static str, len: usize, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting a tuple struct with a particular name and number of fields.
Source§

fn deserialize_tuple<V>( self, len: usize, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting a sequence of values and knows how many values there are without looking at the serialized data.
Source§

fn deserialize_option<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting an optional value. Read more
Source§

fn deserialize_identifier<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting the name of a struct field or the discriminant of an enum variant.
Source§

fn deserialize_i128<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, Self::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i128 value. Read more
Source§

fn deserialize_u128<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, Self::Error>
where V: Visitor<'de>,

Hint that the Deserialize type is expecting an u128 value. Read more
Source§

fn is_human_readable(&self) -> bool

Determine whether Deserialize implementations should expect to deserialize their human-readable form. Read more
Source§

impl From<Num> for Value

Source§

fn from(value: Num) -> Value

Converts to this type from the input type.
Source§

impl From<f32> for Num

Source§

fn from(value: f32) -> Num

Converts to this type from the input type.
Source§

impl From<f64> for Num

Source§

fn from(value: f64) -> Num

Converts to this type from the input type.
Source§

impl From<i128> for Num

Source§

fn from(value: i128) -> Num

Converts to this type from the input type.
Source§

impl From<i16> for Num

Source§

fn from(value: i16) -> Num

Converts to this type from the input type.
Source§

impl From<i32> for Num

Source§

fn from(value: i32) -> Num

Converts to this type from the input type.
Source§

impl From<i64> for Num

Source§

fn from(value: i64) -> Num

Converts to this type from the input type.
Source§

impl From<i8> for Num

Source§

fn from(value: i8) -> Num

Converts to this type from the input type.
Source§

impl From<isize> for Num

Source§

fn from(value: isize) -> Num

Converts to this type from the input type.
Source§

impl From<u128> for Num

Source§

fn from(value: u128) -> Num

Converts to this type from the input type.
Source§

impl From<u16> for Num

Source§

fn from(value: u16) -> Num

Converts to this type from the input type.
Source§

impl From<u32> for Num

Source§

fn from(value: u32) -> Num

Converts to this type from the input type.
Source§

impl From<u64> for Num

Source§

fn from(value: u64) -> Num

Converts to this type from the input type.
Source§

impl From<u8> for Num

Source§

fn from(value: u8) -> Num

Converts to this type from the input type.
Source§

impl From<usize> for Num

Source§

fn from(value: usize) -> Num

Converts to this type from the input type.
Source§

impl FromStr for Num

Source§

type Err = Either<ParseIntError, ParseFloatError>

The associated error which can be returned from parsing.
Source§

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

Parses a string s to return a value of this type. Read more
Source§

impl PartialEq for Num

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Num

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for Num

Auto Trait Implementations§

§

impl Freeze for Num

§

impl RefUnwindSafe for Num

§

impl Send for Num

§

impl Sync for Num

§

impl Unpin for Num

§

impl UnsafeUnpin for Num

§

impl UnwindSafe for Num

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.