Struct Value 

pub struct Value { /* private fields */ }

A dynamic value that can represent null, booleans, numbers, strings, bytes, arrays, or objects.

Value is exactly one pointer in size and uses tagged pointers for efficient type discrimination. Small values like null, booleans, and small integers are stored inline without heap allocation.

Implementations

impl Value

pub const NULL: Self

JSON null value.

pub const FALSE: Self

JSON false value.

pub const TRUE: Self

JSON true value.

pub fn value_type(&self) -> ValueType

Returns the type of this value.

pub fn is_null(&self) -> bool

Returns true if this is the null value.

pub fn is_bool(&self) -> bool

Returns true if this is a boolean.

pub fn is_true(&self) -> bool

Returns true if this is true.

pub fn is_false(&self) -> bool

Returns true if this is false.

pub fn is_number(&self) -> bool

Returns true if this is a number.

pub fn is_string(&self) -> bool

Returns true if this is a string.

pub fn is_bytes(&self) -> bool

Returns true if this is bytes.

pub fn is_array(&self) -> bool

Returns true if this is an array.

pub fn is_object(&self) -> bool

Returns true if this is an object.

pub fn is_datetime(&self) -> bool

Returns true if this is a datetime.

pub fn is_qname(&self) -> bool

Returns true if this is a qualified name.

pub fn is_uuid(&self) -> bool

Returns true if this is a UUID.

pub fn as_bool(&self) -> Option<bool>

Converts this value to a bool. Returns None if not a boolean.

pub fn as_number(&self) -> Option<&VNumber>

Gets a reference to this value as a VNumber. Returns None if not a number.

pub fn as_number_mut(&mut self) -> Option<&mut VNumber>

Gets a mutable reference to this value as a VNumber.

pub fn as_string(&self) -> Option<&VString>

Gets a reference to this value as a VString. Returns None if not a string.

pub fn as_string_mut(&mut self) -> Option<&mut VString>

Gets a mutable reference to this value as a VString.

pub fn is_safe_string(&self) -> bool

Returns true if this is a safe string (marked as pre-escaped HTML, etc.).

A safe string is a string with the safe flag set. Inline strings are never safe.

pub fn as_safe_string(&self) -> Option<&VSafeString>

Gets a reference to this value as a VSafeString. Returns None if not a safe string.

pub fn as_safe_string_mut(&mut self) -> Option<&mut VSafeString>

Gets a mutable reference to this value as a VSafeString.

pub fn as_bytes(&self) -> Option<&VBytes>

Gets a reference to this value as VBytes. Returns None if not bytes.

pub fn as_bytes_mut(&mut self) -> Option<&mut VBytes>

Gets a mutable reference to this value as VBytes.

pub fn as_array(&self) -> Option<&VArray>

Gets a reference to this value as a VArray. Returns None if not an array.

pub fn as_array_mut(&mut self) -> Option<&mut VArray>

Gets a mutable reference to this value as a VArray.

pub fn as_object(&self) -> Option<&VObject>

Gets a reference to this value as a VObject. Returns None if not an object.

pub fn as_object_mut(&mut self) -> Option<&mut VObject>

Gets a mutable reference to this value as a VObject.

pub fn as_datetime(&self) -> Option<&VDateTime>

Gets a reference to this value as a VDateTime. Returns None if not a datetime.

pub fn as_datetime_mut(&mut self) -> Option<&mut VDateTime>

Gets a mutable reference to this value as a VDateTime.

pub fn as_qname(&self) -> Option<&VQName>

Gets a reference to this value as a VQName. Returns None if not a qualified name.

pub fn as_qname_mut(&mut self) -> Option<&mut VQName>

Gets a mutable reference to this value as a VQName.

pub fn as_uuid(&self) -> Option<&VUuid>

Gets a reference to this value as a VUuid. Returns None if not a UUID.

pub fn as_uuid_mut(&mut self) -> Option<&mut VUuid>

Gets a mutable reference to this value as a VUuid.

pub fn take(&mut self) -> Value

Takes this value, replacing it with Value::NULL.

impl Value

pub fn destructure(self) -> Destructured

Destructure this value into an enum for pattern matching (by ownership).

pub fn destructure_ref(&self) -> DestructuredRef<'_>

Destructure this value into an enum for pattern matching (by reference).

pub fn destructure_mut(&mut self) -> DestructuredMut<'_>

Destructure this value into an enum for pattern matching (by mutable reference).

Trait Implementations

impl AsMut<Value> for VArray

fn as_mut(&mut self) -> &mut Value

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

impl AsMut<Value> for VBytes

fn as_mut(&mut self) -> &mut Value

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

impl AsMut<Value> for VNumber

fn as_mut(&mut self) -> &mut Value

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

impl AsMut<Value> for VObject

fn as_mut(&mut self) -> &mut Value

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

impl AsMut<Value> for VSafeString

fn as_mut(&mut self) -> &mut Value

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

impl AsMut<Value> for VString

fn as_mut(&mut self) -> &mut Value

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

impl AsRef<Value> for VArray

fn as_ref(&self) -> &Value

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

impl AsRef<Value> for VBytes

fn as_ref(&self) -> &Value

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

impl AsRef<Value> for VNumber

fn as_ref(&self) -> &Value

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

impl AsRef<Value> for VObject

fn as_ref(&self) -> &Value

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

impl AsRef<Value> for VSafeString

fn as_ref(&self) -> &Value

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

impl AsRef<Value> for VString

fn as_ref(&self) -> &Value

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

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 Default for Value

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Value

fn drop(&mut self)

Executes the destructor for this type.

impl Facet<'_> for Value

const SHAPE: &'static Shape

The shape of this type, including: whether it’s a Struct, an Enum, something else?

impl From<&[u8]> for Value

Available on crate feature alloc only.

fn from(data: &[u8]) -> Self

Converts to this type from the input type.

impl From<&String> for Value

Available on crate feature alloc only.

fn from(s: &String) -> Self

Converts to this type from the input type.

impl From<&str> for Value

Available on crate feature alloc only.

fn from(s: &str) -> Self

Converts to this type from the input type.

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

fn from(opt: Option<T>) -> Self

Converts to this type from the input type.

impl From<String> for Value

Available on crate feature alloc only.

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<VArray> for Value

fn from(arr: VArray) -> Self

Converts to this type from the input type.

impl From<VBytes> for Value

fn from(b: VBytes) -> Self

Converts to this type from the input type.

impl From<VDateTime> for Value

Available on crate feature alloc only.

fn from(dt: VDateTime) -> Self

Converts to this type from the input type.

impl From<VNumber> for Value

fn from(n: VNumber) -> Self

Converts to this type from the input type.

impl From<VObject> for Value

fn from(obj: VObject) -> Self

Converts to this type from the input type.

impl From<VQName> for Value

Available on crate feature alloc only.

fn from(qname: VQName) -> Self

Converts to this type from the input type.

impl From<VSafeString> for Value

fn from(s: VSafeString) -> Self

Converts to this type from the input type.

impl From<VString> for Value

fn from(s: VString) -> Self

Converts to this type from the input type.

impl From<VUuid> for Value

Available on crate feature alloc only.

fn from(uuid: VUuid) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Value

Available on crate feature alloc only.

fn from(data: Vec<u8>) -> Self

Converts to this type from the input type.

impl From<bool> for Value

fn from(b: bool) -> Self

Converts to this type from the input type.

impl From<f32> for Value

Available on crate feature alloc only.

fn from(v: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Value

Available on crate feature alloc only.

fn from(v: f64) -> Self

Converts to this type from the input type.

impl From<i16> for Value

Available on crate feature alloc only.

fn from(v: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Value

Available on crate feature alloc only.

fn from(v: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Value

Available on crate feature alloc only.

fn from(v: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Value

Available on crate feature alloc only.

fn from(v: i8) -> Self

Converts to this type from the input type.

impl From<isize> for Value

Available on crate feature alloc only.

fn from(v: isize) -> Self

Converts to this type from the input type.

impl From<u16> for Value

Available on crate feature alloc only.

fn from(v: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Value

Available on crate feature alloc only.

fn from(v: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Value

Available on crate feature alloc only.

fn from(v: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Value

Available on crate feature alloc only.

fn from(v: u8) -> Self

Converts to this type from the input type.

impl From<usize> for Value

Available on crate feature alloc only.

fn from(v: usize) -> Self

Converts to this type from the input type.

impl<K: Into<VString>, V: Into<Value>> FromIterator<(K, V)> for Value

Available on crate feature alloc only.

fn from_iter<I: IntoIterator<Item = (K, V)>>(iter: I) -> Self

Collect key-value pairs into an object Value.

impl<T: Into<Value>> FromIterator<T> for Value

Available on crate feature alloc only.

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

Collect into an array Value.

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 PartialEq for Value

fn eq(&self, other: &Self) -> 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 Eq for Value

impl Send for Value

impl Sync for Value