Struct Document 

pub struct Document {
    pub id: DocumentId,
    pub title: String,
    pub value: CrdtValue,
    pub created_at: u64,
    pub modified_at: u64,
    pub metadata: HashMap<String, String>,
}

A document with metadata.

Fields

id: DocumentId

Document ID.

title: String

Document title/name.

value: CrdtValue

The CRDT value.

created_at: u64

Creation timestamp.

modified_at: u64

Last modified timestamp.

metadata: HashMap<String, String>

Document metadata.

Implementations

impl Document

pub fn new_text( id: DocumentId, title: impl Into<String>, replica_id: &str, ) -> Self

Create a new text document.

pub fn new_rich_text( id: DocumentId, title: impl Into<String>, replica_id: &str, ) -> Self

Create a new rich text document.

pub fn new_json( id: DocumentId, title: impl Into<String>, replica_id: &str, ) -> Self

Create a new JSON document.

pub fn document_type(&self) -> DocumentType

Get the document type.

pub fn touch(&mut self)

Touch the modified timestamp.

pub fn set_metadata(&mut self, key: impl Into<String>, value: impl Into<String>)

Set metadata.

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

Get metadata.

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Document

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

where __S: Serializer,

Serialize this value into the given Serde serializer.