Struct bonsaidb_core::document::OwnedDocument

pub struct OwnedDocument {
    pub header: Header,
    pub contents: Bytes,
}

Contains a serialized document in the database.

Fields

header: Header

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

contents: Bytes

The serialized bytes of the stored item.

Trait Implementations

impl AsMut<Header> for OwnedDocument

fn as_mut(&mut self) -> &mut Header

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[u8]> for OwnedDocument

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

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Header> for OwnedDocument

fn as_ref(&self) -> &Header

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for OwnedDocument

fn clone(&self) -> OwnedDocument

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OwnedDocument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OwnedDocument

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C> Document<C> for OwnedDocument

where C: Collection,

type Bytes = Vec<u8>

The bytes type used in the interface.

fn contents(&self) -> Result<C::Contents, Error>

where C: SerializedCollection,

Retrieves contents through deserialization into the type D.

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

where C: SerializedCollection,

Stores contents into this document.

fn id(&self) -> &DocumentId

Returns the unique key for this document.

fn header(&self) -> AnyHeader<C::PrimaryKey>

Returns the header of this document.

fn set_header(&mut self, header: Header) -> Result<(), Error>

Sets the header to the new header.

fn bytes(&self) -> Result<Vec<u8>, Error>

Returns the contents of this document, serialized.

fn set_collection_header( &mut self, header: CollectionHeader<C::PrimaryKey> ) -> Result<(), Error>

Sets the header to the new collection header.

impl HasHeader for OwnedDocument

fn header(&self) -> Result<Header, Error>

Returns the header for this instance.

impl Serialize for OwnedDocument

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 OwnedDocument> for CollectionDocument<C>

where C: SerializedCollection,

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.