Enum faunadb::client::Value

pub enum Value {
    Annotated(AnnotatedValue),
    Simple(SimpleValue),
}

Represents any value returned from Fauna.

Read the docs

Variants

Annotated(AnnotatedValue)

A value with an annotation for its type definition.

Simple(SimpleValue)

A value with a direct mapping to the types supported in JSON.

Methods

impl Value

pub const fn null() -> Value

A helper to get a Null value.

pub fn get<I: ValueIndex>(&self, index: I) -> Option<&Value>

Index into a Fauna Array or Object. A string index can be used to access a value in an Object, and a usize index can be used to access an element of an Array.

Returns None if the type of self does not match the type of the index or the given key does not exist in the map or the given index is not within the bounds of the array.

let mut obj = BTreeMap::new();
obj.insert("foo", "bar");

let value = Value::from(vec![obj]);
assert_eq!(Some("bar"), value[0]["foo"].as_str());

pub fn get_mut<I: ValueIndex>(&mut self, index: I) -> Option<&mut Value>

Mutably index into a Fauna Array or Object. A string index can be used to access a value in an Object, and a usize index can be used to access an element of an Array.

Returns None if the type of self does not match the type of the index or the given key does not exist in the map or the given index is not within the bounds of the array.

let mut obj = BTreeMap::new();
obj.insert("cat", "purr");

let mut obj_value = Value::from(obj);
*obj_value.get_mut("cat").unwrap() = Value::from("meow");

let mut ary_value = Value::from(vec!["meow"]);
*ary_value.get_mut(0).unwrap() = Value::from("purr");

pub fn is_string(&self) -> bool

true if the Value is a String.

pub fn as_str(&self) -> Option<&str>

Returns a &str if the value is a String, otherwise None.

pub fn into_string(self) -> Option<String>

Transforms the Value to a String if it's a string, otherwise None.

pub fn is_number(&self) -> bool

true if the Value is a Number.

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

Returns a Number for number values, otherwise None.

pub fn is_u64(&self) -> bool

true if the Value is a u64.

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

Returns a u64 for u64 values, otherwise None.

pub fn is_i64(&self) -> bool

true if the Value is a i64.

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

Returns a i64 for i64 values, otherwise None.

pub fn is_f64(&self) -> bool

true if the Value is a f64.

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

Returns a f64 for f64 values, otherwise None.

pub fn is_f32(&self) -> bool

true if the Value is a f32.

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

Returns a f32 for f32 values, otherwise None.

pub fn is_bool(&self) -> bool

true if the Value is a bool.

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

Returns a bool for bool values, otherwise None.

pub fn is_array(&self) -> bool

true if the Value is an Array.

pub fn as_array(&self) -> Option<&Vec<Value>>

Returns an Array for Array values, otherwise None.

pub fn into_array(self) -> Option<Vec<Value>>

Transforms the Value into an Array if an array, otherwise None.

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

Returns a mutable Array for Array values, otherwise None.

pub fn is_object(&self) -> bool

true if the Value is an Object.

pub fn as_object(&self) -> Option<&BTreeMap<String, Value>>

Returns an Object for Object values, otherwise None.

pub fn as_object_mut(&mut self) -> Option<&mut BTreeMap<String, Value>>

Returns a mutable Object for Object values, otherwise None.

pub fn into_object(self) -> Option<BTreeMap<String, Value>>

Transforms the Value into an Object if an object, otherwise None.

pub fn is_null(&self) -> bool

true if the Value is Null.

pub fn is_reference(&self) -> bool

true if the Value is a Ref.

pub fn as_reference(&self) -> Option<&Ref<'static>>

Returns a Ref for Ref values, otherwise None.

pub fn get_reference(&self) -> Option<&Ref<'static>>

Finds a nearest Ref if found and if taken from an Object, otherwise None.

pub fn is_query(&self) -> bool

true if the Value is a Query.

pub fn as_query(&self) -> Option<&Value>

Returns a Query for Query values, otherwise None.

pub fn is_bytes(&self) -> bool

true if the Value is a set of Bytes.

pub fn as_bytes(&self) -> Option<&Bytes<'static>>

Returns Bytes for sets of Bytes, otherwise None.

pub fn is_date(&self) -> bool

true if the Value is a Date.

pub fn as_date(&self) -> Option<NaiveDate>

Returns a NaiveDate for Date values, otherwise None.

pub fn is_set(&self) -> bool

true if the Value is a Set.

pub fn as_set(&self) -> Option<&Value>

Returns a Set for Set values, otherwise None.

pub fn is_timestamp(&self) -> bool

true if the Value is a Timestamp.

pub fn as_timestamp(&self) -> Option<DateTime<Utc>>

Returns a DateTime for Timestamp values, otherwise None.

Trait Implementations

impl PartialEq<Value> for Value

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Default for Value

fn default() -> Self

Returns the "default value" for a type.

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

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

Performs the conversion.

impl<T> From<T> for Value where
    T: Into<Number>, 

fn from(t: T) -> Self

Performs the conversion.

impl From<Ref<'static>> for Value

fn from(t: Ref<'static>) -> Self

Performs the conversion.

impl From<NaiveDate> for Value

fn from(t: NaiveDate) -> Self

Performs the conversion.

impl From<DateTime<Utc>> for Value

fn from(t: DateTime<Utc>) -> Self

Performs the conversion.

impl<V> From<Vec<V>> for Value where
    V: Into<Value>, 

fn from(t: Vec<V>) -> Self

Performs the conversion.

impl<S, V> From<BTreeMap<S, V>> for Value where
    S: Into<String>,
    V: Into<Value>, 

fn from(map: BTreeMap<S, V>) -> Self

Performs the conversion.

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: ValueIndex> Index<I> for Value

type Output = Value

The returned type after indexing.

fn index(&self, index: I) -> &Value

Performs the indexing (container[index]) operation.

impl Debug for Value

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

Formats the value using the given formatter.

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<'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.