Enum convex::Value

pub enum Value {
    Null,
    Int64(i64),
    Float64(f64),
    Boolean(bool),
    String(String),
    Bytes(Vec<u8>),
    Array(Vec<Value>),
    Object(BTreeMap<String, Value>),
}

A value that can be passed as an argument or returned from Convex functions. They correspond to the supported Convex types.

Variants

Null

Int64(i64)

Float64(f64)

Boolean(bool)

String(String)

Bytes(Vec<u8>)

Array(Vec<Value>)

Object(BTreeMap<String, Value>)

Implementations

impl Value

pub fn export(self) -> JsonValue

Converts this value to a JSON value in the json export format. https://docs.convex.dev/database/types

It is possible for distinct Convex values to be serialized to the same JSON value by this method. For instance, strings and binary values are both exported as JSON strings. However, it is possible to convert the exported value back to a unique Convex value if you also have the Type value associated with the original Convex value (see roundtrip.rs).

Example

use convex::Value;
use serde_json::{
    json,
    Value as JsonValue,
};

let value = Value::Bytes(vec![0b00000000, 0b00010000, 0b10000011]);
assert_eq!(JsonValue::from(value.clone()), json!({ "$bytes": "ABCD" }));
assert_eq!(value.export(), json!("ABCD"));

Trait Implementations

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 From<&str> for Value

fn from(v: &str) -> Value

Converts to this type from the input type.

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

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

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

fn from(value: Value) -> JsonValue

Converts to this type from the input type.

impl From<Vec<Value>> for Value

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

Converts to this type from the input type.

impl From<Vec<u8>> for Value

fn from(v: Vec<u8>) -> 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<f64> for Value

fn from(v: f64) -> 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 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: &Self) -> 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: &Self) -> 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 TryFrom<Value> for Value

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: JsonValue) -> Result<Self>

Performs the conversion.

impl Eq for Value