Enum surrealdb_sql::Value

pub enum Value {
    None,
    Null,
    Bool(bool),
    Number(Number),
    Strand(Strand),
    Duration(Duration),
    Datetime(Datetime),
    Uuid(Uuid),
    Array(Array),
    Object(Object),
    Geometry(Geometry),
    Bytes(Bytes),
    Thing(Thing),
    Param(Param),
    Idiom(Idiom),
    Table(Table),
    Mock(Mock),
    Regex(Regex),
    Cast(Box<Cast>),
    Block(Box<Block>),
    Range(Box<Range>),
    Edges(Box<Edges>),
    Future(Box<Future>),
    Constant(Constant),
    Function(Box<Function>),
    Subquery(Box<Subquery>),
    Expression(Box<Expression>),
    Query(Query),
    Model(Box<Model>),
}

Variants

None

Null

Bool(bool)

Number(Number)

Strand(Strand)

Duration(Duration)

Datetime(Datetime)

Uuid(Uuid)

Array(Array)

Object(Object)

Geometry(Geometry)

Bytes(Bytes)

Thing(Thing)

Param(Param)

Idiom(Idiom)

Table(Table)

Mock(Mock)

Regex(Regex)

Cast(Box<Cast>)

Block(Box<Block>)

Range(Box<Range>)

Edges(Box<Edges>)

Future(Box<Future>)

Constant(Constant)

Function(Box<Function>)

Subquery(Box<Subquery>)

Expression(Box<Expression>)

Query(Query)

Model(Box<Model>)

Implementations

impl Value

pub fn base() -> Self

Create an empty Object Value

pub fn ok(self) -> Result<Value, Error>

Convert this Value to a Result

pub fn some(self) -> Option<Value>

Convert this Value to an Option

pub fn is_none_or_null(&self) -> bool

Check if this Value is NONE or NULL

pub fn is_none(&self) -> bool

Check if this Value is NONE

pub fn is_null(&self) -> bool

Check if this Value is NULL

pub fn is_some(&self) -> bool

Check if this Value not NONE or NULL

pub fn is_bool(&self) -> bool

Check if this Value is a boolean value

pub fn is_true(&self) -> bool

Check if this Value is TRUE or ‘true’

pub fn is_false(&self) -> bool

Check if this Value is FALSE or ‘false’

pub fn is_truthy(&self) -> bool

Check if this Value is truthy

pub fn is_uuid(&self) -> bool

Check if this Value is a UUID

pub fn is_thing(&self) -> bool

Check if this Value is a Thing

pub fn is_mock(&self) -> bool

Check if this Value is a Mock

pub fn is_param(&self) -> bool

Check if this Value is a Param

pub fn is_range(&self) -> bool

Check if this Value is a Range

pub fn is_table(&self) -> bool

Check if this Value is a Table

pub fn is_strand(&self) -> bool

Check if this Value is a Strand

pub fn is_query(&self) -> bool

Check if this Value is a Query

pub fn is_bytes(&self) -> bool

Check if this Value is a float Number

pub fn is_array(&self) -> bool

Check if this Value is an Array

pub fn is_object(&self) -> bool

Check if this Value is an Object

pub fn is_number(&self) -> bool

Check if this Value is a Number

pub fn is_datetime(&self) -> bool

Check if this Value is a Datetime

pub fn is_duration(&self) -> bool

Check if this Value is a Duration

pub fn is_record(&self) -> bool

Check if this Value is a Thing

pub fn is_record_of_table(&self, table: String) -> bool

Check if this Value is a Thing, and belongs to a certain table

pub fn is_geometry(&self) -> bool

Check if this Value is a Geometry

pub fn is_int(&self) -> bool

Check if this Value is an int Number

pub fn is_float(&self) -> bool

Check if this Value is a float Number

pub fn is_decimal(&self) -> bool

Check if this Value is a decimal Number

pub fn is_nan(&self) -> bool

Check if this Value is a Number but is a NAN

pub fn is_integer(&self) -> bool

Check if this Value is a Number and is an integer

pub fn is_positive(&self) -> bool

Check if this Value is a Number and is positive

pub fn is_negative(&self) -> bool

Check if this Value is a Number and is negative

pub fn is_zero_or_positive(&self) -> bool

Check if this Value is a Number and is zero or positive

pub fn is_zero_or_negative(&self) -> bool

Check if this Value is a Number and is zero or negative

pub fn is_record_type(&self, types: &[Table]) -> bool

Check if this Value is a Thing of a specific type

pub fn is_geometry_type(&self, types: &[String]) -> bool

Check if this Value is a Geometry of a specific type

pub fn as_string(self) -> String

Convert this Value into a String

pub fn as_raw_string(self) -> String

Converts this Value into an unquoted String

pub fn to_raw_string(&self) -> String

Converts this Value into an unquoted String

pub fn to_idiom(&self) -> Idiom

Converts this Value into a field name

pub fn can_start_idiom(&self) -> bool

Returns if this value can be the start of a idiom production.

pub fn to_operations(&self) -> Result<Vec<Operation>, Error>

Try to convert this Value into a set of JSONPatch operations

pub fn into_json(self) -> Json

Converts a surrealdb::sq::Value into a serde_json::Value

This converts certain types like Thing into their simpler formats instead of the format used internally by SurrealDB.

pub fn could_be_table(self) -> Value

Treat a string as a table name

pub fn kindof(&self) -> &'static str

Treat a string as a table name

pub fn record(self) -> Option<Thing>

Fetch the record id if there is one

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

Check if this Value is equal to another Value

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

Check if all Values in an Array are equal to another Value

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

Check if any Values in an Array are equal to another Value

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

Fuzzy check if this Value is equal to another Value

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

Fuzzy check if all Values in an Array are equal to another Value

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

Fuzzy check if any Values in an Array are equal to another Value

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

Check if this Value contains another Value

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

Check if all Values in an Array contain another Value

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

Check if any Values in an Array contain another Value

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

Check if this Value intersects another Value

pub fn lexical_cmp(&self, other: &Value) -> Option<Ordering>

Compare this Value to another Value lexicographically

pub fn natural_cmp(&self, other: &Value) -> Option<Ordering>

Compare this Value to another Value using natural numerical comparison

pub fn natural_lexical_cmp(&self, other: &Value) -> Option<Ordering>

Compare this Value to another Value lexicographically and using natural numerical comparison

impl Value

pub fn all(&self) -> Self

impl Value

pub fn clear(&mut self) -> Result<(), Error>

impl Value

pub fn first(&self) -> Self

impl Value

pub fn flatten(self) -> Self

impl Value

pub fn last(&self) -> Self

impl Value

pub fn pick(&self, path: &[Part]) -> Self

Synchronous method for getting a field from a Value

impl Value

pub fn put(&mut self, path: &[Part], val: Value)

Synchronous method for setting a field on a Value

impl Value

pub fn rid(&self) -> Value

impl Value

pub fn walk(&self, path: &[Part]) -> Vec<(Idiom, Self)>

Trait Implementations

impl Add<Value> for Array

type Output = Array

The resulting type after applying the + operator.

fn add(self, other: Value) -> Self

Performs the + operation.

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

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

Formats the value using the given formatter.

impl Default for Value

fn default() -> Value

Returns the “default value” for a type.

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<'a> From<&'a Value> for Cow<'a, Value>

fn from(v: &'a Value) -> Cow<'a, Value>

Converts to this type from the input type.

impl From<&Value> for Vec<u8>

fn from(v: &Value) -> Vec<u8>

Converts to this type from the input type.

impl From<&Vec<u8>> for Value

fn from(v: &Vec<u8>) -> Self

Converts to this type from the input type.

impl From<&str> for Value

fn from(v: &str) -> Self

Converts to this type from the input type.

impl From<[f64; 2]> for Value

fn from(v: [f64; 2]) -> Self

Converts to this type from the input type.

impl From<(f64, f64)> for Value

fn from(v: (f64, f64)) -> Self

Converts to this type from the input type.

impl From<Array> for Value

fn from(v: Array) -> Self

Converts to this type from the input type.

impl From<BTreeMap<&str, Value>> for Value

fn from(v: BTreeMap<&str, Value>) -> Self

Converts to this type from the input type.

impl From<BTreeMap<String, Value>> for Value

fn from(v: BTreeMap<String, Value>) -> Self

Converts to this type from the input type.

impl From<Block> for Value

fn from(v: Block) -> Self

Converts to this type from the input type.

impl From<Box<Edges>> for Value

fn from(v: Box<Edges>) -> Self

Converts to this type from the input type.

impl From<Bytes> for Value

fn from(v: Bytes) -> Self

Converts to this type from the input type.

impl From<Cast> for Value

fn from(v: Cast) -> Self

Converts to this type from the input type.

impl From<Constant> for Value

fn from(v: Constant) -> Self

Converts to this type from the input type.

impl From<DateTime<Utc>> for Value

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

Converts to this type from the input type.

impl From<Datetime> for Value

fn from(v: Datetime) -> Self

Converts to this type from the input type.

impl From<Decimal> for Value

fn from(v: Decimal) -> Self

Converts to this type from the input type.

impl From<DefineTableStatement> for Value

fn from(v: DefineTableStatement) -> Self

Converts to this type from the input type.

impl From<Duration> for Value

fn from(v: Duration) -> Self

Converts to this type from the input type.

impl From<Edges> for Value

fn from(v: Edges) -> Self

Converts to this type from the input type.

impl From<Expression> for Value

fn from(v: Expression) -> Self

Converts to this type from the input type.

impl From<Function> for Value

fn from(v: Function) -> Self

Converts to this type from the input type.

impl From<Future> for Value

fn from(v: Future) -> Self

Converts to this type from the input type.

impl From<Geometry> for Value

fn from(v: Geometry) -> Self

Converts to this type from the input type.

impl From<HashMap<&str, Value>> for Value

fn from(v: HashMap<&str, Value>) -> Self

Converts to this type from the input type.

impl From<HashMap<String, Value>> for Value

fn from(v: HashMap<String, Value>) -> Self

Converts to this type from the input type.

impl From<Id> for Value

fn from(v: Id) -> Self

Converts to this type from the input type.

impl From<Idiom> for Value

fn from(v: Idiom) -> Self

Converts to this type from the input type.

impl From<Mock> for Value

fn from(v: Mock) -> Self

Converts to this type from the input type.

impl From<Model> for Value

fn from(v: Model) -> Self

Converts to this type from the input type.

impl From<Number> for Value

fn from(v: Number) -> Self

Converts to this type from the input type.

impl From<Object> for Value

fn from(v: Object) -> Self

Converts to this type from the input type.

impl From<Operation> for Value

fn from(v: Operation) -> Self

Converts to this type from the input type.

impl From<Option<String>> for Value

fn from(v: Option<String>) -> Self

Converts to this type from the input type.

impl From<Option<Value>> for Value

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

Converts to this type from the input type.

impl From<Param> for Value

fn from(v: Param) -> Self

Converts to this type from the input type.

impl From<Point> for Value

fn from(v: Point<f64>) -> Self

Converts to this type from the input type.

impl From<Query> for Value

fn from(q: Query) -> Self

Converts to this type from the input type.

impl From<Range> for Value

fn from(v: Range) -> Self

Converts to this type from the input type.

impl From<Regex> for Value

fn from(v: Regex) -> Self

Converts to this type from the input type.

impl From<Strand> for Value

fn from(v: Strand) -> Self

Converts to this type from the input type.

impl From<String> for Value

fn from(v: String) -> Self

Converts to this type from the input type.

impl From<Subquery> for Value

fn from(v: Subquery) -> Self

Converts to this type from the input type.

impl From<Table> for Value

fn from(v: Table) -> Self

Converts to this type from the input type.

impl From<Thing> for Value

fn from(v: Thing) -> Self

Converts to this type from the input type.

impl From<Uuid> for Value

fn from(v: Uuid) -> Self

Converts to this type from the input type.

impl From<Uuid> for Value

fn from(v: Uuid) -> Self

Converts to this type from the input type.

impl From<Value> for Array

fn from(v: Value) -> Self

Converts to this type from the input type.

impl From<Value> for Block

fn from(v: Value) -> Self

Converts to this type from the input type.

impl<'a> From<Value> for Cow<'a, Value>

fn from(v: Value) -> Cow<'a, Value>

Converts to this type from the input type.

impl From<Value> for Future

fn from(v: Value) -> Self

Converts to this type from the input type.

impl From<Value> for Value

fn from(value: Value) -> Self

Converts to this type from the input type.

impl From<Value> for Vec<u8>

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

Converts to this type from the input type.

impl From<Vec<&str>> for Value

fn from(v: Vec<&str>) -> Self

Converts to this type from the input type.

impl From<Vec<Number>> for Value

fn from(v: Vec<Number>) -> Self

Converts to this type from the input type.

impl From<Vec<Operation>> for Value

fn from(v: Vec<Operation>) -> Self

Converts to this type from the input type.

impl From<Vec<String>> for Value

fn from(v: Vec<String>) -> Self

Converts to this type from the input type.

impl From<Vec<Value>> for Value

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

Converts to this type from the input type.

impl From<Vec<bool>> for Value

fn from(v: Vec<bool>) -> Self

Converts to this type from the input type.

impl From<Vec<i32>> for Value

fn from(v: Vec<i32>) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Value

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

Converts to this type from the input type.

impl From<bool> for Value

fn from(v: bool) -> Self

Converts to this type from the input type.

impl From<f32> for Value

fn from(v: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Value

fn from(v: f64) -> Self

Converts to this type from the input type.

impl From<i128> for Value

fn from(v: i128) -> Self

Converts to this type from the input type.

impl From<i16> for Value

fn from(v: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Value

fn from(v: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Value

fn from(v: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Value

fn from(v: i8) -> Self

Converts to this type from the input type.

impl From<isize> for Value

fn from(v: isize) -> Self

Converts to this type from the input type.

impl From<u128> for Value

fn from(v: u128) -> Self

Converts to this type from the input type.

impl From<u16> for Value

fn from(v: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Value

fn from(v: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Value

fn from(v: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Value

fn from(v: u8) -> Self

Converts to this type from the input type.

impl From<usize> for Value

fn from(v: usize) -> Self

Converts to this type from the input type.

impl FromIterator<(String, Value)> for Value

fn from_iter<I: IntoIterator<Item = (String, Value)>>(iter: I) -> Self

Creates a value from an iterator.

impl FromIterator<Value> for Array

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

Creates a value from an iterator.

impl FromIterator<Value> for Value

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

Creates a value from an iterator.

impl<'js> FromJs<'js> for Value

fn from_js(ctx: &Ctx<'js>, val: Value<'js>) -> Result<Self, Error>

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<'js> IntoJs<'js> for &Value

fn into_js(self, ctx: &Ctx<'js>) -> Result<Value<'js>, Error>

impl<'js> IntoJs<'js> for Value

fn into_js(self, ctx: &Ctx<'js>) -> Result<Value<'js>, Error>

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq 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: &Rhs) -> bool

This method 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: &Value) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Revisioned for Value

fn revision() -> u16

Returns the current revision of this type.

fn serialize_revisioned<W: Write>(&self, writer: &mut W) -> Result<(), Error>

Serializes the struct using the specficifed writer.

fn deserialize_revisioned<R: Read>(reader: &mut R) -> Result<Self, Error>

Deserializes a new instance of the struct from the specficifed reader.

fn type_id() -> TypeId

where Self: 'static,

Returns the type id of this type.

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

type Output = Array

The resulting type after applying the - operator.

fn sub(self, other: Value) -> Self

Performs the - operation.

impl TryFrom<Value> for DateTime<Utc>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Datetime

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Decimal

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Duration

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Number

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Object

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for String

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Uuid

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Vec<Value>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for bool

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for f32

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for f64

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for i128

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for i16

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for i32

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for i64

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for i8

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for u128

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for u16

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for u32

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for u64

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for u8

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Value

impl StructuralPartialEq for Value