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 new<Contents>(id: DocumentId, contents: Contents) -> BorrowedDocument<'a> where
    Contents: Into<CowBytes<'a>>, 

Returns a new instance with the id and content bytes.

pub fn with_contents<C>(
    id: <C as Collection>::PrimaryKey,
    contents: &<C as SerializedCollection>::Contents
) -> Result<BorrowedDocument<'a>, Error> where
    C: SerializedCollection, 

Returns a new instance with contents, after serializing.

pub fn into_owned(self) -> OwnedDocument

Converts this document to an owned document.

Trait Implementations

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

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

Performs the conversion.

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

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

Performs the conversion.

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

pub fn as_ref(&self) -> &Header

Performs the conversion.

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

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

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

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

type Bytes = CowBytes<'a>

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

pub fn id(&self) -> DocumentId

Returns the unique key for this document.

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

Sets the header to the new collection header.

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

pub fn from(doc: &'b BorrowedDocument<'b>) -> NamedReference<'a, Id>

Performs the conversion.

impl<'a> HasHeader for BorrowedDocument<'a>

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

Returns the header for this instance.

impl<'a, 'b, Id> Nameable<'a, Id> for &'a BorrowedDocument<'b>

pub fn name(self) -> Result<NamedReference<'a, Id>, Error>

Returns this name as a NamedReference.

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

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 BorrowedDocument<'a>> 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 BorrowedDocument<'a>
) -> Result<CollectionDocument<C>, <CollectionDocument<C> as TryFrom<&'a BorrowedDocument<'a>>>::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.

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

Performs the conversion.