Enum Value 

#[repr(u64)]
pub enum Value {
    U8(u8),
    I8(i8),
    U16(u16),
    I16(i16),
    U32(u32),
    V32(u32),
    I32(i32),
    Z32(i32),
    U64(u64),
    V64(u64),
    I64(i64),
    Z64(i64),
    F32(f32),
    F64(f64),
    Bool(bool),
    Null = 32_768,
    String(ArcStr),
    Bytes(PBytes),
    Error(Arc<Value>),
    Array(ValArray),
    Map(Map),
    Decimal(Arc<Decimal>),
    DateTime(Arc<DateTime<Utc>>),
    Duration(Arc<Duration>),
    Abstract(Abstract),
}

A dynamically-typed value that can be published and subscribed.

This type is divided into two subtypes: copy and clone. If the tag word is <= COPY_MAX then the type is copy, otherwise it must be cloned. Additionally, the tag word values are THE SAME as the values of the cases of Typ. Getting the Typ of a value is therefore a simply copy of the discriminant of Value.

It is essential that when adding variants you update COPY_MAX and Typ correctly. If adding a non copy type, you will also need to update the implementation of clone to match and delegate the clone operation.

Variants

U8(u8)

unsigned byte

I8(i8)

signed byte

U16(u16)

u16

I16(i16)

i16

U32(u32)

full 4 byte u32

V32(u32)

LEB128 varint, 1 - 5 bytes depending on value

I32(i32)

full 4 byte i32

Z32(i32)

LEB128 varint zigzag encoded, 1 - 5 bytes depending on abs(value)

U64(u64)

full 8 byte u64

V64(u64)

LEB128 varint, 1 - 10 bytes depending on value

I64(i64)

full 8 byte i64

Z64(i64)

LEB128 varint zigzag encoded, 1 - 10 bytes depending on abs(value)

F32(f32)

4 byte ieee754 single precision float

F64(f64)

8 byte ieee754 double precision float

Bool(bool)

boolean true

Null = 32_768

Empty value

String(ArcStr)

unicode string

Bytes(PBytes)

byte array

Error(Arc<Value>)

An explicit error

Array(ValArray)

An array of values

Map(Map)

A Map of values

Decimal(Arc<Decimal>)

fixed point decimal type

DateTime(Arc<DateTime<Utc>>)

UTC timestamp

Duration(Arc<Duration>)

Duration

Abstract(Abstract)

Abstract

Implementations

impl Value

pub fn to_string_naked(&self) -> String

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

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

pub fn fmt_ext( &self, f: &mut Formatter<'_>, esc: &Escape, types: bool, ) -> Result

impl Value

pub fn approx_eq(&self, v: &Self) -> bool

pub fn discriminant(&self) -> u64

return the discriminant tag of this value

pub fn is_copy(&self) -> bool

return true if this value will be cloned by a direct bitwise copy

pub fn cast(self, typ: Typ) -> Option<Value>

Whatever value is attempt to turn it into the type specified

pub fn cast_to<T: FromValue + Sized>(self) -> Result<T>

cast value directly to any type implementing FromValue

pub fn get_as<T: FromValue + Sized>(self) -> Option<T>

get the value as T, return None if the value isn’t a T.

don’t attempt to cast.

pub fn downcast_ref<T: Any + Send + Sync>(&self) -> Option<&T>

downcast an abstract value to it’s concrete type

return None if the value isn’t abstract, or if T is not it’s concrete type.

pub unsafe fn get_as_unchecked<T>(&self) -> &T

get a reference to the payload of the value without checking the tag

If you are wrong about what kind of value you have then this could cause undefined behavior.

pub fn err<T: Error>(e: T) -> Value

construct a Value::Error from e

pub fn error<S: Into<ArcStr>>(e: S) -> Value

construct a Value::Error from e

pub fn number(&self) -> bool

return true if the value is some kind of number, otherwise false.

pub fn integer(&self) -> bool

return true if the value is some kind of integer, otherwise false.

pub fn flatten(self) -> impl Iterator<Item = Value>

return an iterator that will perform a depth first traversal of the specified value. All array elements will be flattened into non array values.

Trait Implementations

impl Add for Value

type Output = Value

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self

Performs the + operation.

impl Clone for Value

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Value

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Value

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

Formats the value using the given formatter.

impl Div for Value

type Output = Value

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self

Performs the / operation.

impl<T: Into<Value> + Copy> From<&T> for Value

fn from(v: &T) -> Value

Converts to this type from the input type.

impl From<&'static str> for Value

fn from(v: &'static str) -> Value

Converts to this type from the input type.

impl<const S: usize, T: Into<Value>> From<[T; S]> for Value

fn from(v: [T; S]) -> Self

Converts to this type from the input type.

impl<T: Into<Value>, U: Into<Value>> From<(T, U)> for Value

fn from((t, u): (T, U)) -> Value

Converts to this type from the input type.

impl<T: Into<Value>, U: Into<Value>, V: Into<Value>> From<(T, U, V)> for Value

fn from((t, u, v): (T, U, V)) -> Value

Converts to this type from the input type.

impl<T: Into<Value>, U: Into<Value>, V: Into<Value>, W: Into<Value>> From<(T, U, V, W)> for Value

fn from((t, u, v, w): (T, U, V, W)) -> Value

Converts to this type from the input type.

impl<T: Into<Value>, U: Into<Value>, V: Into<Value>, W: Into<Value>, X: Into<Value>> From<(T, U, V, W, X)> for Value

fn from((t, u, v, w, x): (T, U, V, W, X)) -> Value

Converts to this type from the input type.

impl<T: Into<Value>, U: Into<Value>, V: Into<Value>, W: Into<Value>, X: Into<Value>, Y: Into<Value>> From<(T, U, V, W, X, Y)> for Value

fn from((t, u, v, w, x, y): (T, U, V, W, X, Y)) -> Value

Converts to this type from the input type.

impl<T: Into<Value>, U: Into<Value>, V: Into<Value>, W: Into<Value>, X: Into<Value>, Y: Into<Value>, Z: Into<Value>> From<(T, U, V, W, X, Y, Z)> for Value

fn from((t, u, v, w, x, y, z): (T, U, V, W, X, Y, Z)) -> Value

Converts to this type from the input type.

impl<T: Into<Value>, U: Into<Value>, V: Into<Value>, W: Into<Value>, X: Into<Value>, Y: Into<Value>, Z: Into<Value>, A: Into<Value>> From<(T, U, V, W, X, Y, Z, A)> for Value

fn from((t, u, v, w, x, y, z, a): (T, U, V, W, X, Y, Z, A)) -> Value

Converts to this type from the input type.

impl<T: Into<Value>, U: Into<Value>, V: Into<Value>, W: Into<Value>, X: Into<Value>, Y: Into<Value>, Z: Into<Value>, A: Into<Value>, B: Into<Value>> From<(T, U, V, W, X, Y, Z, A, B)> for Value

fn from((t, u, v, w, x, y, z, a, b): (T, U, V, W, X, Y, Z, A, B)) -> Value

Converts to this type from the input type.

impl<T: Into<Value>, U: Into<Value>, V: Into<Value>, W: Into<Value>, X: Into<Value>, Y: Into<Value>, Z: Into<Value>, A: Into<Value>, B: Into<Value>, C: Into<Value>> From<(T, U, V, W, X, Y, Z, A, B, C)> for Value

fn from((t, u, v, w, x, y, z, a, b, c): (T, U, V, W, X, Y, Z, A, B, C)) -> Value

Converts to this type from the input type.

impl<T: Into<Value>, U: Into<Value>, V: Into<Value>, W: Into<Value>, X: Into<Value>, Y: Into<Value>, Z: Into<Value>, A: Into<Value>, B: Into<Value>, C: Into<Value>, D: Into<Value>> From<(T, U, V, W, X, Y, Z, A, B, C, D)> for Value

fn from( (t, u, v, w, x, y, z, a, b, c, d): (T, U, V, W, X, Y, Z, A, B, C, D), ) -> Value

Converts to this type from the input type.

impl<T: Into<Value>, U: Into<Value>, V: Into<Value>, W: Into<Value>, X: Into<Value>, Y: Into<Value>, Z: Into<Value>, A: Into<Value>, B: Into<Value>, C: Into<Value>, D: Into<Value>, E: Into<Value>> From<(T, U, V, W, X, Y, Z, A, B, C, D, E)> for Value

fn from( (t, u, v, w, x, y, z, a, b, c, d, e): (T, U, V, W, X, Y, Z, A, B, C, D, E), ) -> Value

Converts to this type from the input type.

impl<T: Into<Value>, U: Into<Value>, V: Into<Value>, W: Into<Value>, X: Into<Value>, Y: Into<Value>, Z: Into<Value>, A: Into<Value>, B: Into<Value>, C: Into<Value>, D: Into<Value>, E: Into<Value>, F: Into<Value>> From<(T, U, V, W, X, Y, Z, A, B, C, D, E, F)> for Value

fn from( (t, u, v, w, x, y, z, a, b, c, d, e, f): (T, U, V, W, X, Y, Z, A, B, C, D, E, F), ) -> Value

Converts to this type from the input type.

impl<T: Into<Value>, U: Into<Value>, V: Into<Value>, W: Into<Value>, X: Into<Value>, Y: Into<Value>, Z: Into<Value>, A: Into<Value>, B: Into<Value>, C: Into<Value>, D: Into<Value>, E: Into<Value>, F: Into<Value>, G: Into<Value>> From<(T, U, V, W, X, Y, Z, A, B, C, D, E, F, G)> for Value

fn from( (t, u, v, w, x, y, z, a, b, c, d, e, f, g): (T, U, V, W, X, Y, Z, A, B, C, D, E, F, G), ) -> Value

Converts to this type from the input type.

impl<T: Into<Value>, U: Into<Value>, V: Into<Value>, W: Into<Value>, X: Into<Value>, Y: Into<Value>, Z: Into<Value>, A: Into<Value>, B: Into<Value>, C: Into<Value>, D: Into<Value>, E: Into<Value>, F: Into<Value>, G: Into<Value>, H: Into<Value>> From<(T, U, V, W, X, Y, Z, A, B, C, D, E, F, G, H)> for Value

fn from( (t, u, v, w, x, y, z, a, b, c, d, e, f, g, h): (T, U, V, W, X, Y, Z, A, B, C, D, E, F, G, H), ) -> Value

Converts to this type from the input type.

impl<T: Into<Value>, U: Into<Value>, V: Into<Value>, W: Into<Value>, X: Into<Value>, Y: Into<Value>, Z: Into<Value>, A: Into<Value>, B: Into<Value>, C: Into<Value>, D: Into<Value>, E: Into<Value>, F: Into<Value>, G: Into<Value>, H: Into<Value>, I: Into<Value>> From<(T, U, V, W, X, Y, Z, A, B, C, D, E, F, G, H, I)> for Value

fn from( (t, u, v, w, x, y, z, a, b, c, d, e, f, g, h, i): (T, U, V, W, X, Y, Z, A, B, C, D, E, F, G, H, I), ) -> Value

Converts to this type from the input type.

impl<T: Into<Value>, U: Into<Value>, V: Into<Value>, W: Into<Value>, X: Into<Value>, Y: Into<Value>, Z: Into<Value>, A: Into<Value>, B: Into<Value>, C: Into<Value>, D: Into<Value>, E: Into<Value>, F: Into<Value>, G: Into<Value>, H: Into<Value>, I: Into<Value>, J: Into<Value>> From<(T, U, V, W, X, Y, Z, A, B, C, D, E, F, G, H, I, J)> for Value

fn from( (t, u, v, w, x, y, z, a, b, c, d, e, f, g, h, i, j): (T, U, V, W, X, Y, Z, A, B, C, D, E, F, G, H, I, J), ) -> Value

Converts to this type from the input type.

impl<T: Into<Value>, U: Into<Value>, V: Into<Value>, W: Into<Value>, X: Into<Value>, Y: Into<Value>, Z: Into<Value>, A: Into<Value>, B: Into<Value>, C: Into<Value>, D: Into<Value>, E: Into<Value>, F: Into<Value>, G: Into<Value>, H: Into<Value>, I: Into<Value>, J: Into<Value>, K: Into<Value>> From<(T, U, V, W, X, Y, Z, A, B, C, D, E, F, G, H, I, J, K)> for Value

fn from( (t, u, v, w, x, y, z, a, b, c, d, e, f, g, h, i, j, k): (T, U, V, W, X, Y, Z, A, B, C, D, E, F, G, H, I, J, K), ) -> Value

Converts to this type from the input type.

impl<T: Into<Value>, U: Into<Value>, V: Into<Value>, W: Into<Value>, X: Into<Value>, Y: Into<Value>, Z: Into<Value>, A: Into<Value>, B: Into<Value>, C: Into<Value>, D: Into<Value>, E: Into<Value>, F: Into<Value>, G: Into<Value>, H: Into<Value>, I: Into<Value>, J: Into<Value>, K: Into<Value>, L: Into<Value>> From<(T, U, V, W, X, Y, Z, A, B, C, D, E, F, G, H, I, J, K, L)> for Value

fn from( (t, u, v, w, x, y, z, a, b, c, d, e, f, g, h, i, j, k, l): (T, U, V, W, X, Y, Z, A, B, C, D, E, F, G, H, I, J, K, L), ) -> Value

Converts to this type from the input type.

impl<T: Into<Value>, U: Into<Value>, V: Into<Value>, W: Into<Value>, X: Into<Value>, Y: Into<Value>, Z: Into<Value>, A: Into<Value>, B: Into<Value>, C: Into<Value>, D: Into<Value>, E: Into<Value>, F: Into<Value>, G: Into<Value>, H: Into<Value>, I: Into<Value>, J: Into<Value>, K: Into<Value>, L: Into<Value>, M: Into<Value>> From<(T, U, V, W, X, Y, Z, A, B, C, D, E, F, G, H, I, J, K, L, M)> for Value

fn from( (t, u, v, w, x, y, z, a, b, c, d, e, f, g, h, i, j, k, l, m): (T, U, V, W, X, Y, Z, A, B, C, D, E, F, G, H, I, J, K, L, M), ) -> Value

Converts to this type from the input type.

impl From<ArcStr> for Value

fn from(v: ArcStr) -> Value

Converts to this type from the input type.

impl<K: Into<Value>, V: Into<Value>> From<BTreeMap<K, V>> for Value

fn from(v: BTreeMap<K, V>) -> Self

Converts to this type from the input type.

impl<K: Into<Value>> From<BTreeSet<K>> for Value

fn from(s: BTreeSet<K>) -> Self

Converts to this type from the input type.

impl<T> From<BitFlags<T>> for Value

where T: BitFlag, <T as RawBitFlags>::Numeric: Into<Value>,

fn from(v: BitFlags<T>) -> Self

Converts to this type from the input type.

impl From<Bytes> for Value

fn from(v: Bytes) -> Value

Converts to this type from the input type.

impl From<CompactString> for Value

fn from(v: CompactString) -> Value

Converts to this type from the input type.

impl From<DateTime<Utc>> for Value

fn from(v: DateTime<Utc>) -> Value

Converts to this type from the input type.

impl From<Decimal> for Value

fn from(value: Decimal) -> Self

Converts to this type from the input type.

impl From<Duration> for Value

fn from(v: Duration) -> Value

Converts to this type from the input type.

impl<T: Into<Value> + Clone + Send + Sync> From<GPooled<Vec<T>>> for Value

fn from(v: GPooled<Vec<T>>) -> Value

Converts to this type from the input type.

impl<K: Into<Value>, V: Into<Value>, S: BuildHasher + Default> From<HashMap<K, V, S>> for Value

fn from(h: HashMap<K, V, S>) -> Value

Converts to this type from the input type.

impl<K: Into<Value>, S: BuildHasher + Default> From<HashSet<K, S>> for Value

fn from(h: HashSet<K, S>) -> Value

Converts to this type from the input type.

impl<K: Into<Value>, V: Into<Value>, S: BuildHasher + Default> From<IndexMap<K, V, S>> for Value

fn from(h: IndexMap<K, V, S>) -> Value

Converts to this type from the input type.

impl<K: Into<Value>, S: BuildHasher + Default> From<IndexSet<K, S>> for Value

fn from(h: IndexSet<K, S>) -> Value

Converts to this type from the input type.

impl<T: Into<Value>> From<Option<T>> for Value

fn from(o: Option<T>) -> Value

Converts to this type from the input type.

impl From<Path> for Value

fn from(v: Path) -> Value

Converts to this type from the input type.

impl<const S: usize, T: Into<Value>> From<SmallVec<[T; S]>> for Value

fn from(v: SmallVec<[T; S]>) -> Self

Converts to this type from the input type.

impl From<String> for Value

fn from(v: String) -> Value

Converts to this type from the input type.

impl From<Uuid> for Value

fn from(id: Uuid) -> Self

Converts to this type from the input type.

impl From<ValArray> for Value

fn from(v: ValArray) -> Value

Converts to this type from the input type.

impl<T: Into<Value>> From<Vec<T>> for Value

fn from(v: Vec<T>) -> Value

Converts to this type from the input type.

impl From<bool> for Value

fn from(v: bool) -> Value

Converts to this type from the input type.

impl From<f32> for Value

fn from(v: f32) -> Value

Converts to this type from the input type.

impl From<f64> for Value

fn from(v: f64) -> Value

Converts to this type from the input type.

impl From<i16> for Value

fn from(v: i16) -> Value

Converts to this type from the input type.

impl From<i32> for Value

fn from(v: i32) -> Value

Converts to this type from the input type.

impl From<i64> for Value

fn from(v: i64) -> Value

Converts to this type from the input type.

impl From<i8> for Value

fn from(v: i8) -> Value

Converts to this type from the input type.

impl From<u16> for Value

fn from(v: u16) -> Value

Converts to this type from the input type.

impl From<u32> for Value

fn from(v: u32) -> Value

Converts to this type from the input type.

impl From<u64> for Value

fn from(v: u64) -> Value

Converts to this type from the input type.

impl From<u8> for Value

fn from(v: u8) -> Value

Converts to this type from the input type.

impl From<usize> for Value

fn from(v: usize) -> Value

Converts to this type from the input type.

impl FromIterator<Value> for ValArray

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

Creates a value from an iterator.

impl FromStr for Value

type Err = Error

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.

impl FromValue for Value

fn from_value(v: Value) -> Result<Self>

attempt to cast v to the type of self using any reasonable means

fn get(v: Value) -> Option<Self>

extract the type of self from v if the type of v is equivelent to the type of self, otherwise return None.

impl Hash for Value

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Mul for Value

type Output = Value

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self

Performs the * operation.

impl Not for Value

type Output = Value

The resulting type after applying the ! operator.

fn not(self) -> Self

Performs the unary ! operation.

impl Ord for Value

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl Pack for Value

fn encoded_len(&self) -> usize

fn encode(&self, buf: &mut impl BufMut) -> Result<(), PackError>

fn decode(buf: &mut impl Buf) -> Result<Self, PackError>

fn const_encoded_len() -> Option<usize>

fn decode_into(&mut self, buf: &mut impl Buf) -> Result<(), PackError>

where Self: Sized,

impl PartialEq for Value

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Value

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl Rem for Value

type Output = Value

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self::Output

Performs the % operation.

impl Serialize for Value

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Value

type Output = Value

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self

Performs the - operation.

impl Eq for Value