Skip to main content

ValueRef

Enum ValueRef

pub enum ValueRef<'a> {
    String(Cow<'a, str>),
    Float(f64),
    Int(i64),
    Buffer(Cow<'a, [u8]>),
    Empty,
    Boolean(bool),
    List(Cow<'a, [Value]>),
}

Expand description

A borrowed parameter value that may be a string, a number, or empty. It is intended to be paired with the ParamValue trait.

The owned equivalent of this type is Value.

Variants§

String(Cow<'a, str>)

A text value of arbitrary length

Float(f64)

A floating point number

Int(i64)

A integral number

Buffer(Cow<'a, [u8]>)

Arbitrary binary data

Empty

No value specified

Boolean(bool)

A true/false value

List(Cow<'a, [Value]>)

A collection of heterogenous Value

Implementations§

impl<'a> ValueRef<'a>

pub fn new(s: &'a str) -> Self

Convert a string value into a precise value type by trying successive types to parse, defaulting to storing the string as-is.

pub const fn wrap(s: &'a str) -> Self

Create a string ValueRef

pub fn coerce_bool(&mut self) -> Result<(), ParamValueParseError>

Store the value as a boolean

pub fn coerce_f64(&mut self) -> Result<(), ParamValueParseError>

Store the value as a floating point number

pub fn coerce_i64(&mut self) -> Result<(), ParamValueParseError>

Store the value as an integer

pub fn coerce_str(&mut self) -> Result<(), ParamValueParseError>

Store the value as a string

pub fn coerce_empty(&mut self)

Discard the value, leaving this value ValueRef::Empty

pub fn coerce_buffer(&mut self) -> Result<(), ParamValueParseError>

Store the value as a byte buffer

pub fn coerce_list(&mut self) -> Result<(), ParamValueParseError>

Store the value as a list

Trait Implementations§

impl<'a> AsRef<ValueRef<'a>> for ParamCow<'a>

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

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Clone for ValueRef<'a>

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

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

impl<'a> Debug for ValueRef<'a>

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

Formats the value using the given formatter. Read more

impl<'a> Default for ValueRef<'a>

fn default() -> ValueRef<'a>

Returns the “default value” for a type. Read more

impl Display for ValueRef<'_>

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

Formats the value using the given formatter. Read more

impl Eq for ValueRef<'_>

impl<'a> From<&'a Value> for ValueRef<'a>

fn from(value: &'a Value) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for ValueRef<'a>

fn from(value: &'a str) -> Self

Converts to this type from the input type.

impl<'a> From<&f32> for ValueRef<'a>

fn from(value: &f32) -> Self

Converts to this type from the input type.

impl<'a> From<&f64> for ValueRef<'a>

fn from(value: &f64) -> Self

Converts to this type from the input type.

impl<'a> From<&i8> for ValueRef<'a>

fn from(value: &i8) -> Self

Converts to this type from the input type.

impl<'a> From<&i16> for ValueRef<'a>

fn from(value: &i16) -> Self

Converts to this type from the input type.

impl<'a> From<&i32> for ValueRef<'a>

fn from(value: &i32) -> Self

Converts to this type from the input type.

impl<'a> From<&i64> for ValueRef<'a>

fn from(value: &i64) -> Self

Converts to this type from the input type.

impl<'a> From<&u8> for ValueRef<'a>

fn from(value: &u8) -> Self

Converts to this type from the input type.

impl<'a> From<&u16> for ValueRef<'a>

fn from(value: &u16) -> Self

Converts to this type from the input type.

impl<'a> From<&u32> for ValueRef<'a>

fn from(value: &u32) -> Self

Converts to this type from the input type.

impl<'a> From<&u64> for ValueRef<'a>

fn from(value: &u64) -> Self

Converts to this type from the input type.

impl<'a> From<&usize> for ValueRef<'a>

fn from(value: &usize) -> Self

Converts to this type from the input type.

impl<'a> From<Cow<'a, [Value]>> for ValueRef<'a>

fn from(value: Cow<'a, [Value]>) -> Self

Converts to this type from the input type.

impl<'a> From<Cow<'a, str>> for ValueRef<'a>

fn from(value: Cow<'a, str>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<f32>> for ValueRef<'a>

fn from(value: Option<f32>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<f64>> for ValueRef<'a>

fn from(value: Option<f64>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<i8>> for ValueRef<'a>

fn from(value: Option<i8>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<i16>> for ValueRef<'a>

fn from(value: Option<i16>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<i32>> for ValueRef<'a>

fn from(value: Option<i32>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<i64>> for ValueRef<'a>

fn from(value: Option<i64>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<u8>> for ValueRef<'a>

fn from(value: Option<u8>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<u16>> for ValueRef<'a>

fn from(value: Option<u16>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<u32>> for ValueRef<'a>

fn from(value: Option<u32>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<u64>> for ValueRef<'a>

fn from(value: Option<u64>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<usize>> for ValueRef<'a>

fn from(value: Option<usize>) -> Self

Converts to this type from the input type.

impl From<String> for ValueRef<'_>

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<ValueRef<'_>> for f32

fn from(value: ValueRef<'_>) -> Self

Converts to this type from the input type.

impl From<ValueRef<'_>> for f64

fn from(value: ValueRef<'_>) -> Self

Converts to this type from the input type.

impl From<ValueRef<'_>> for i32

fn from(value: ValueRef<'_>) -> Self

Converts to this type from the input type.

impl From<ValueRef<'_>> for i64

fn from(value: ValueRef<'_>) -> Self

Converts to this type from the input type.

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

fn from(value: ValueRef<'a>) -> Self

Converts to this type from the input type.

impl From<Vec<Value>> for ValueRef<'static>

fn from(value: Vec<Value>) -> Self

Converts to this type from the input type.

impl From<bool> for ValueRef<'_>

fn from(value: bool) -> Self

Converts to this type from the input type.

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

fn from(value: f32) -> Self

Converts to this type from the input type.

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

fn from(value: f64) -> Self

Converts to this type from the input type.

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

fn from(value: i8) -> Self

Converts to this type from the input type.

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

fn from(value: i16) -> Self

Converts to this type from the input type.

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

fn from(value: i32) -> Self

Converts to this type from the input type.

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

fn from(value: i64) -> Self

Converts to this type from the input type.

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

fn from(value: u8) -> Self

Converts to this type from the input type.

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

fn from(value: u16) -> Self

Converts to this type from the input type.

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

fn from(value: u32) -> Self

Converts to this type from the input type.

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

fn from(value: u64) -> Self

Converts to this type from the input type.

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

fn from(value: usize) -> Self

Converts to this type from the input type.

impl<U: Into<Value>> FromIterator<U> for ValueRef<'static>

fn from_iter<T: IntoIterator<Item = U>>(iter: T) -> Self

Creates a value from an iterator. Read more

impl FromStr for ValueRef<'_>

type Err = ParamValueParseError

The associated error which can be returned from parsing.

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

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

impl Hash for ValueRef<'_>

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

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more

impl ParamValue for ValueRef<'_>

fn is_empty(&self) -> bool

Check if the value is empty

fn is_i64(&self) -> bool

Check if the value is an integer

fn is_f64(&self) -> bool

Check if the value is a floating point number explicitly. An integral number might still be usable as a floating point number

fn is_buffer(&self) -> bool

Check if the value is an arbitrary buffer

fn is_str(&self) -> bool

Check if the value is stored as an explicit string. All variants can be coerced to a string.

fn is_boolean(&self) -> bool

Check if the value is a boolean

fn to_bool(&self) -> Result<bool, ParamValueParseError>

Get the value as a bool, if possible

fn to_f64(&self) -> Result<f64, ParamValueParseError>

Get the value as an f64, if possible

fn to_i64(&self) -> Result<i64, ParamValueParseError>

Get the value as an i64, if possible

fn to_str(&self) -> Cow<'_, str>

Get the value as a string

fn to_buffer(&self) -> Result<Cow<'_, [u8]>, ParamValueParseError>

Get the value as a byte buffer, if possible. Read more

fn parse<T: FromStr>(&self) -> Result<T, T::Err>

Convert the value’s string representation to T if possible

fn as_bytes(&self) -> Cow<'_, [u8]>

Convert the value to a byte string, the bytes of the string representation.

fn as_ref(&self) -> ValueRef<'_>

Get a reference to the stored value

fn data_len(&self) -> usize

Get the size of the stored data type

fn is_list(&self) -> bool

Check if the value is a list

fn as_slice(&self) -> Cow<'_, [Value]>

Get the value as a slice

fn is_numeric(&self) -> bool

Check if the value is of either numeric type.

fn to_f32(&self) -> Result<f32, ParamValueParseError>

Get the value as an f32, if possible

fn to_i32(&self) -> Result<i32, ParamValueParseError>

Get the value as an i32, if possible

fn to_u64(&self) -> Result<u64, ParamValueParseError>

Get the value as an u64, if possible

fn as_str(&self) -> Cow<'_, str>

Get the value as a string, possibly borrowed

impl<'a> PartialEq for ValueRef<'a>

fn eq(&self, other: &ValueRef<'a>) -> bool

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl PartialEq<&str> for ValueRef<'_>

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl PartialEq<String> for ValueRef<'_>

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl PartialEq<Value> for ValueRef<'_>

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

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

fn eq(&self, other: &ValueRef<'a>) -> bool

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl PartialEq<bool> for ValueRef<'_>

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl PartialEq<f64> for ValueRef<'_>

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl PartialEq<i64> for ValueRef<'_>

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl PartialEq<str> for ValueRef<'_>

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl<'a> PartialOrd for ValueRef<'a>

fn partial_cmp(&self, other: &ValueRef<'a>) -> Option<Ordering>

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

1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more

1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl<'a> StructuralPartialEq for ValueRef<'a>

Auto Trait Implementations§

impl<'a> Freeze for ValueRef<'a>

impl<'a> RefUnwindSafe for ValueRef<'a>

impl<'a> Send for ValueRef<'a>

impl<'a> Sync for ValueRef<'a>

impl<'a> Unpin for ValueRef<'a>

impl<'a> UnsafeUnpin for ValueRef<'a>

impl<'a> UnwindSafe for ValueRef<'a>

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.