Enum Value 

pub enum Value {
    Null,
    Bool(bool),
    Integer(i64),
    String(String),
    Bytes(Vec<u8>),
    Link(Cid),
    List(Vec<Value>),
    Map(BTreeMap<String, Value>),
}

A value in the atproto data model.

There is no float variant, and that absence is the point rather than an omission. A float has several encodings of the same number and no exact equality, so a record containing one has no single hash; atproto removed them from the model outright. A JSON number that happens to be written 123.0 is an integer and parses as one, and one that is not is refused.

Variants

Null

JSON null.

Bool(bool)

A boolean.

Integer(i64)

A signed 64-bit integer, which is the only number the model has.

String(String)

A UTF-8 string.

Bytes(Vec<u8>)

A byte string, written {"$bytes": "..."} in JSON.

Link(Cid)

A link to another block, written {"$link": "..."} in JSON.

List(Vec<Value>)

An ordered list.

Map(BTreeMap<String, Value>)

A map with string keys. Insertion order is not kept, because the encoding defines its own order and nothing else may depend on one.

Implementations

impl Value

pub fn from_json(json: &Value) -> Result<Self, DataError>

Parses one JSON value into the data model.

use didbot_data::Value;
let json = serde_json::json!({"a": 1, "b": [true, null]});
assert!(Value::from_json(&json).is_ok());
assert!(Value::from_json(&serde_json::json!(1.5)).is_err());

pub fn object_from_json(json: &Value) -> Result<Self, DataError>

Parses a JSON value that must be an object, which is what a record is.

The data model permits any value inside a record, but the record itself — and every block a repository stores — is a map. Upstream’s first invalid vector is the bare string "blah", so this is a rule with a test rather than a tidiness.

fn parse(json: &Value, path: &str) -> Result<Self, DataError>

Parses json at path.

pub fn to_json(&self) -> Value

Renders back to the JSON representation.

Round-tripping is not free: a JSON document that wrote 123.0 comes back as 123, because the data model holds one integer and not two spellings of it. Everything the model can distinguish survives.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

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

fn cmp(&self, other: &Value) -> 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 PartialEq for Value

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