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

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

Performs the conversion.

impl AsRef<[u8]> for OwnedDocument

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

Performs the conversion.

impl AsRef<Header> for OwnedDocument

pub fn as_ref(&self) -> &Header

Performs the conversion.

impl Clone for OwnedDocument

pub 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

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl<'a, C> Document<C> for OwnedDocument where
    C: Collection, 

type Bytes = Vec<u8, Global>

The bytes type used in the interface.

pub fn contents(&self) -> Result<<C as SerializedCollection>::Contents, Error> where
    C: SerializedCollection, 

Retrieves contents through deserialization into the type D.

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

Stores contents into this document.

pub fn id(&self) -> DocumentId

Returns the unique key for this document.

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

Returns the header of this document.

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

Sets the header to the new header.

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

Returns the contents of this document, serialized.

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

Sets the header to the new collection header.

impl HasHeader for OwnedDocument

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

Returns the header for this instance.

impl Serialize for OwnedDocument

pub fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::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.

pub fn try_from(
    value: &'a OwnedDocument
) -> Result<CollectionDocument<C>, <CollectionDocument<C> as TryFrom<&'a OwnedDocument>>::Error>

Performs the conversion.