Struct bonsaidb_core::document::BorrowedDocument

pub struct BorrowedDocument<'a> {
    pub header: Header,
    pub contents: CowBytes<'a>,
}

Contains a serialized document in the database.

Fields

header: Header

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

contents: CowBytes<'a>

The serialized bytes of the stored item.

Implementations

impl<'a> BorrowedDocument<'a>

pub fn into_owned(self) -> OwnedDocument

Converts this document to an owned document.

Methods from Deref<Target = Header>

pub fn emit(&self) -> Mappings<(), ()>

Creates a Map result with an empty key and value.

pub fn emit_key<K: for<'a> Key<'a>>(&self, key: K) -> Mappings<K, ()>

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

pub fn emit_value<Value>(&self, value: Value) -> Mappings<(), Value>

Creates a Map result with value and an empty key.

pub fn emit_key_and_value<K: for<'a> Key<'a>, Value>(
    &self,
    key: K,
    value: Value
) -> Mappings<K, Value>

Creates a Map result with a key and value.

Trait Implementations

impl<'a> AsRef<[u8]> for BorrowedDocument<'a>

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl<'a> AsRef<Header> for BorrowedDocument<'a>

fn as_ref(&self) -> &Header

Performs the conversion.

impl<'a> Clone for BorrowedDocument<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BorrowedDocument<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for BorrowedDocument<'a>

type Target = Header

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for BorrowedDocument<'a>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de: 'a, 'a> Deserialize<'de> for BorrowedDocument<'a>

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

Deserialize this value from the given Serde deserializer.

impl<'a> Document<'a> for BorrowedDocument<'a>

type Bytes = CowBytes<'a>

The bytes type used in the interface.

fn new(id: u64, contents: impl Into<CowBytes<'a>>) -> Self

Creates a new document with contents.

fn with_contents<S: SerializedCollection<Contents = S>>(
    id: u64,
    contents: &S
) -> Result<Self, Error>

Creates a new document with serialized bytes from contents.

fn contents<D>(&self) -> Result<D::Contents, Error> where
    D: SerializedCollection<Contents = D>, 

Retrieves contents through deserialization into the type D.

fn set_contents<S: SerializedCollection<Contents = S>>(
    &mut self,
    contents: &S
) -> Result<(), Error>

Serializes and stores contents into this document.

fn create_new_revision(&self, contents: impl Into<Self::Bytes>) -> Option<Self>

Creates a new revision.

impl<'a, 'b, 'c> From<&'b BorrowedDocument<'b>> for NamedReference<'a>

fn from(doc: &'b BorrowedDocument<'b>) -> Self

Performs the conversion.

impl<'a> Serialize for BorrowedDocument<'a>

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

Serialize this value into the given Serde serializer.

impl<'a, C> TryFrom<&'a BorrowedDocument<'a>> for CollectionDocument<C> where
    C: SerializedCollection, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'a BorrowedDocument<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, 'b, C> TryFrom<&'b CollectionDocument<C>> for BorrowedDocument<'a> where
    C: SerializedCollection, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'b CollectionDocument<C>) -> Result<Self, Self::Error>

Performs the conversion.