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

Returns a new instance with the id and content bytes.

pub fn with_contents<C, PrimaryKey>( id: &PrimaryKey, contents: &C::Contents ) -> Result<Self, Error>

where C: SerializedCollection, PrimaryKey: KeyEncoding<C::PrimaryKey> + ?Sized,

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>

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

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

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

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

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

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

fn as_ref(&self) -> &Header

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

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<'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, C> Document<C> for BorrowedDocument<'a>

where C: Collection,

type Bytes = CowBytes<'a>

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 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 id(&self) -> &DocumentId

Returns the unique key for this document.

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

Sets the header to the new collection header.

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

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

Converts to this type from the input type.

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

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

Returns the header for this instance.

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

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

Returns this name as a NamedReference.

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.