Trait Document 

pub trait Document<C>: Sized
where
    C: Collection,
{
    type Bytes;

    // Required methods
    fn id(&self) -> &DocumentId;
    fn header(&self) -> AnyHeader<C::PrimaryKey>;
    fn set_header(&mut self, header: Header) -> Result<(), Error>;
    fn bytes(&self) -> Result<Vec<u8>, Error>;
    fn contents(&self) -> Result<C::Contents, Error>
       where C: SerializedCollection;
    fn set_contents(&mut self, contents: C::Contents) -> Result<(), Error>
       where C: SerializedCollection;

    // Provided method
    fn set_collection_header(
        &mut self,
        header: CollectionHeader<C::PrimaryKey>,
    ) -> Result<(), Error> { ... }
}

Common interface of a document in BonsaiDb.

Required Associated Types

type Bytes

The bytes type used in the interface.

Required Methods

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

Provided Methods

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

Sets the header to the new collection header.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

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

where C: Collection,

type Bytes = CowBytes<'a>

impl<C> Document<C> for OwnedDocument

where C: Collection,

type Bytes = Vec<u8>