Struct pliantdb_core::document::Document

pub struct Document<'a> {
    pub collection: Id,
    pub header: Cow<'a, Header>,
    pub contents: Cow<'a, [u8]>,
}

Contains a serialized document in the database.

Fields

collection: Id

The Id of the Collection this document belongs to.

header: Cow<'a, Header>

The header of the document, which contains the id and Revision.

contents: Cow<'a, [u8]>

The serialized bytes of the stored item.

Implementations

impl<'a> Document<'a>

#[must_use]pub fn new(id: u64, contents: Cow<'a, [u8]>, collection: Id) -> Self

Creates a new document with contents.

pub fn with_contents<S: Serialize>(
    id: u64,
    contents: &S,
    collection: Id
) -> Result<Self, Error>

Creates a new document with serialized bytes from contents.

pub fn contents<D: Deserialize<'a>>(&'a self) -> Result<D, Error>

Retrieves contents through deserialization into the type D.

pub fn set_contents<S: Serialize>(&mut self, contents: &S) -> Result<(), Error>

Serializes and stores contents into this document.

#[must_use]pub fn create_new_revision(&self, contents: Cow<'a, [u8]>) -> Option<Self>

Creates a new revision.

WARNING: This normally should not be used outside of implementing a backend for PliantDB. To update a document, use set_contents() and send the document with the existing Revision information.

#[must_use]pub fn emit(&self) -> Map<(), ()>

Creates a Map result with an empty key and value.

#[must_use]pub fn emit_key<Key: Key>(&self, key: Key) -> Map<Key, ()>

Creates a Map result with a key and an empty value.

#[must_use]pub fn emit_value<Value: Serialize>(&self, value: Value) -> Map<(), Value>

Creates a Map result with value and an empty key.

#[must_use]pub fn emit_key_and_value<Key: Key, Value: Serialize>(
    &self,
    key: Key,
    value: Value
) -> Map<Key, Value>

Creates a Map result with a key and value.

#[must_use]pub fn to_owned(&self) -> Document<'static>

Clone the document’s data so that it’s no longer borrowed in the original lifetime 'a.

Trait Implementations

impl<'a> Clone for Document<'a>

fn clone(&self) -> Document<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Document<'a>

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl<'a> Serialize for Document<'a>

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

Serialize this value into the given Serde serializer.