Struct Document 

pub struct Document {
    pub id: String,
    pub fields: HashMap<String, Value>,
}

A CRDT-backed document. The primary data unit across all NodeDB engines.

Documents are schemaless: each field maps a string key to a Value. The id field is mandatory and immutable after creation.

Fields

id: String

Document identifier (unique within a collection).

fields: HashMap<String, Value>

Key-value fields. Schema enforcement (if any) happens at the collection level, not the document level.

Implementations

impl Document

pub fn new(id: impl Into<String>) -> Document

Create a new document with the given ID and no fields.

pub fn set(&mut self, key: impl Into<String>, value: Value) -> &mut Document

Set a field value. Returns &mut Self for chaining.

pub fn get(&self, key: &str) -> Option<&Value>

Get a field value by key.

pub fn get_str(&self, key: &str) -> Option<&str>

Get a field as a string, if it exists and is a string.

pub fn get_f64(&self, key: &str) -> Option<f64>

Get a field as f64, if it exists and is numeric.

pub fn to_msgpack(&self) -> Result<Vec<u8>, Error>

Serialize the document to MessagePack bytes.

pub fn from_msgpack(bytes: &[u8]) -> Result<Document, Error>

Deserialize a document from MessagePack bytes.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Document

fn deserialize<__D>( __deserializer: __D, ) -> Result<Document, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'__msgpack_de> FromMessagePack<'__msgpack_de> for Document

fn read<R>(reader: &mut R) -> Result<Document, Error>

where R: Read<'__msgpack_de>, Document: Sized,

Reads the MessagePack representation of this value from the provided reader.

impl PartialEq for Document

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToMessagePack for Document

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

where W: Write,

Writes the MessagePack representation of this value into the provided writer.

impl StructuralPartialEq for Document