pub struct BorrowedDocument<'a> {
    pub header: Header,
    pub contents: CowBytes<'a>,
}
Expand description

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§

source§

impl<'a> BorrowedDocument<'a>

source

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.

source

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

Returns a new instance with contents, after serializing.

source

pub fn into_owned(self) -> OwnedDocument

Converts this document to an owned document.

Trait Implementations§

source§

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

source§

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

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

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

source§

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

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

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

source§

fn as_ref(&self) -> &Header

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

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

source§

fn clone(&self) -> BorrowedDocument<'a>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<'a> Debug for BorrowedDocument<'a>

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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. Read more
source§

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

§

type Bytes = CowBytes<'a>

The bytes type used in the interface.
source§

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

Retrieves contents through deserialization into the type D.
source§

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

Stores contents into this document.
source§

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

Returns the header of this document.
source§

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

Sets the header to the new header.
source§

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

Returns the contents of this document, serialized.
source§

fn id(&self) -> &DocumentId

Returns the unique key for this document.
source§

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

Sets the header to the new collection header.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Returns the header for this instance.
source§

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

source§

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

Returns this name as a NamedReference.
source§

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

source§

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. Read more
source§

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

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

Performs the conversion.
source§

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

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

Performs the conversion.

Auto Trait Implementations§

§

impl<'a> RefUnwindSafe for BorrowedDocument<'a>

§

impl<'a> Send for BorrowedDocument<'a>

§

impl<'a> Sync for BorrowedDocument<'a>

§

impl<'a> Unpin for BorrowedDocument<'a>

§

impl<'a> UnwindSafe for BorrowedDocument<'a>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32 ) -> TaggedParser<'a, Implicit, Self, E>

source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToHex for Twhere T: AsRef<[u8]>,

source§

fn encode_hex<U>(&self) -> Uwhere U: FromIterator<char>,

Encode the hex strict representing self into the result. Lower case letters are used (e.g. f9b4ca)
source§

fn encode_hex_upper<U>(&self) -> Uwhere U: FromIterator<char>,

Encode the hex strict representing self into the result. Upper case letters are used (e.g. F9B4CA)
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,