Struct ledb::RawDocument

pub struct RawDocument(_, _);

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 into_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.

Methods from Deref<Target = Value>

pub fn is_object(&self) -> bool

Returns true if the value is an object.

pub fn as_object(&self) -> Option<&BTreeMap<ObjectKey, Value, Global>>

If the value is an object, returns the associated BTreeMap. Returns None otherwise.

pub fn as_object_mut(
    &mut self
) -> Option<&mut BTreeMap<ObjectKey, Value, Global>>

If the value is an object, returns the associated mutable BTreeMap. Returns None otherwise.

pub fn is_array(&self) -> bool

Returns true if the value is an array.

pub fn as_array(&self) -> Option<&Vec<Value, Global>>

If the value is an array, returns the associated Vec. Returns None otherwise.

pub fn as_array_mut(&mut self) -> Option<&mut Vec<Value, Global>>

If the value is an array, returns the associated mutable Vec. Returns None otherwise.

pub fn is_bytes(&self) -> bool

Returns true if the value is a byte string.

pub fn as_bytes(&self) -> Option<&Vec<u8, Global>>

Returns the associated byte string or None if the value has a different type.

pub fn as_bytes_mut(&mut self) -> Option<&mut Vec<u8, Global>>

Returns the associated mutable byte string or None if the value has a different type.

pub fn is_string(&self) -> bool

Returns true if the value is a string.

pub fn as_string(&self) -> Option<&String>

Returns the associated string or None if the value has a different type.

pub fn as_string_mut(&mut self) -> Option<&mut String>

Returns the associated mutable string or None if the value has a different type.

pub fn is_number(&self) -> bool

Retrns true if the value is a number.

pub fn is_i64(&self) -> bool

Returns true if the Value is a i64. Returns false otherwise.

pub fn is_u64(&self) -> bool

Returns true if the Value is a u64. Returns false otherwise.

pub fn is_f64(&self) -> bool

Returns true if the Value is a f64. Returns false otherwise.

pub fn as_i64(&self) -> Option<i64>

If the Value is a number, return or cast it to a i64. Returns None otherwise.

pub fn as_u64(&self) -> Option<u64>

If the Value is a number, return or cast it to a u64. Returns None otherwise.

pub fn as_f64(&self) -> Option<f64>

If the Value is a number, return or cast it to a f64. Returns None otherwise.

pub fn is_boolean(&self) -> bool

Returns true if the value is a boolean.

pub fn as_boolean(&self) -> Option<bool>

If the value is a Boolean, returns the associated bool. Returns None otherwise.

pub fn is_null(&self) -> bool

Returns true if the value is a Null. Returns false otherwise.

pub fn as_null(&self) -> Option<()>

If the value is a Null, returns (). Returns None otherwise.

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<RawDocument> for RawDocument

fn eq(&self, other: &RawDocument) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RawDocument