Struct RawDocument

pub struct RawDocument(/* private fields */);

Raw document with id representation

Implementations

impl RawDocument

pub fn new(doc: Value) -> Self

Create document using raw data

pub fn with_id(self, id: Primary) -> Self

Add id to document

pub fn without_id(self) -> Self

Remove id from document

pub fn has_id(&self) -> bool

Checks when document has primary key/identifier

pub fn get_id(&self) -> &Option<Primary>

Get the primary key/identifier of document

pub fn req_id(&self) -> Result<Primary>

Require the primary key/identifier of document

pub fn into_inner(self) -> Value

Unwrap document value

pub fn to_bin(&self) -> Result<Vec<u8>>

Convert document to binary representation

At this moment we use CBOR for effectively store documents into DB backend. Since the internal representation does not contains primary identifier, it adds on reading documents from DB.

pub fn from_bin(raw: &[u8]) -> Result<Self>

Restore document from binary representation

At this moment we use CBOR for effectively store documents into DB backend. Since the internal representation does not contains primary identifier, it adds on reading documents from DB.

pub fn from_doc<T>(doc: &T) -> Result<Self>

where T: Serialize + Document + Sized,

Convert typed document to raw representation

Typically the application deals with typed documents which represented by specific structures. The database backend processes generic document representation which is CBOR Value.

pub fn into_doc<T>(self) -> Result<T>

where T: DeserializeOwned + Document,

Restore typed document from raw representation

Typically the application deals with typed documents which represented by specific structures. The database backend processes generic document representation which is CBOR Value.

Trait Implementations

impl Clone for RawDocument

fn clone(&self) -> RawDocument

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RawDocument

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

Formats the value using the given formatter.

impl Deref for RawDocument

type Target = Value

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for RawDocument

fn deref_mut(&mut self) -> &mut Value

Mutably dereferences the value.

impl PartialEq for RawDocument

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