Struct bonsaidb_core::document::OwnedDocument

source · [−]

pub struct OwnedDocument {
    pub header: Header,
    pub contents: Bytes,
}

Expand description

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.

Methods from Deref<Target = Header>

source

pub fn emit(&self) -> Mappings<(), ()>

Creates a Map result with an empty key and value.

source

pub fn emit_key<K: for<'a> Key<'a>>(&self, key: K) -> Mappings<K, ()>

Creates a Map result with a key and an empty value.

source

pub fn emit_value<Value>(&self, value: Value) -> Mappings<(), Value>

Creates a Map result with value and an empty key.

source

pub fn emit_key_and_value<K: for<'a> Key<'a>, Value>(
 &self,
 key: K,
 value: Value
) -> Mappings<K, Value>

Creates a Map result with a key and value.

Trait Implementations

source

impl AsRef<[u8 ]> for OwnedDocument

source

fn as_ref(&self) -> &[u8 ]ⓘNotable traits for &'_ mut [u8 ]`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]`

Performs the conversion.

source

impl AsRef<Header> for OwnedDocument

source

fn as_ref(&self) -> &Header

Performs the conversion.

source

impl Clone for OwnedDocument

source

fn clone(&self) -> OwnedDocument

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 Debug for OwnedDocument

source

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

Formats the value using the given formatter. Read more

source

impl Deref for OwnedDocument

type Target = Header

The resulting type after dereferencing.

source

fn deref(&self) -> &Self::Target

Dereferences the value.

source

impl DerefMut for OwnedDocument

source

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

source

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

source

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

impl Document<'static> for OwnedDocument

type Bytes = Vec<u8>

The bytes type used in the interface.

source

fn new(id: u64, contents: impl Into<Self::Bytes>) -> Self

Creates a new document with contents.

source

fn with_contents<S: SerializedCollection<Contents = S>>(
id: u64,
contents: &S
) -> Result<Self, Error>

Creates a new document with serialized bytes from contents.

source

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

Retrieves contents through deserialization into the type D.

source

fn set_contents<S: SerializedCollection<Contents = S>>(
&mut self,
contents: &S
) -> Result<(), Error>

Serializes and stores contents into this document.

source

fn create_new_revision(&self, contents: impl Into<Self::Bytes>) -> Option<Self>

Creates a new revision. Read more

source

impl Serialize for OwnedDocument

source

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

source

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.

source

fn try_from(value: &'a OwnedDocument) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations

impl RefUnwindSafe for OwnedDocument

impl Send for OwnedDocument

impl Sync for OwnedDocument

impl Unpin for OwnedDocument

impl UnwindSafe for OwnedDocument

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

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

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

Struct bonsaidb_core::document::OwnedDocument

Fields

Methods from Deref<Target = Header>

pub fn emit(&self) -> Mappings<(), ()>

pub fn emit_key<K: for<'a> Key<'a>>(&self, key: K) -> Mappings<K, ()>

pub fn emit_value<Value>(&self, value: Value) -> Mappings<(), Value>

pub fn emit_key_and_value<K: for<'a> Key<'a>, Value>( &self, key: K, value: Value) -> Mappings<K, Value>

Trait Implementations

impl AsRef<[u8]> for OwnedDocument

fn as_ref(&self) -> &[u8]ⓘNotable traits for &'_ mut [u8]impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]

impl AsRef<Header> for OwnedDocument

fn as_ref(&self) -> &Header

impl Clone for OwnedDocument

fn clone(&self) -> OwnedDocument

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

impl Debug for OwnedDocument

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

impl Deref for OwnedDocument

type Target = Header

fn deref(&self) -> &Self::Target

impl DerefMut for OwnedDocument

fn deref_mut(&mut self) -> &mut Self::Target

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

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

impl Document<'static> for OwnedDocument

type Bytes = Vec<u8>

fn new(id: u64, contents: impl Into<Self::Bytes>) -> Self

fn with_contents<S: SerializedCollection<Contents = S>>( id: u64, contents: &S) -> Result<Self, Error>

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

fn set_contents<S: SerializedCollection<Contents = S>>( &mut self, contents: &S) -> Result<(), Error>

fn create_new_revision(&self, contents: impl Into<Self::Bytes>) -> Option<Self>

impl Serialize for OwnedDocument

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where __S: Serializer,

impl<'a, C> TryFrom<&'a OwnedDocument> for CollectionDocument<C> where C: SerializedCollection,

type Error = Error

fn try_from(value: &'a OwnedDocument) -> Result<Self, Self::Error>

Auto Trait Implementations

impl RefUnwindSafe for OwnedDocument

impl Send for OwnedDocument

impl Sync for OwnedDocument

impl Unpin for OwnedDocument

impl UnwindSafe for OwnedDocument

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

pub fn emit_key_and_value<K: for<'a> Key<'a>, Value>(
&self,
key: K,
value: Value
) -> Mappings<K, Value>

impl AsRef<[u8 ]> for OwnedDocument

fn as_ref(&self) -> &[u8 ]ⓘNotable traits for &'_ mut [u8 ]`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]`

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

fn with_contents<S: SerializedCollection<Contents = S>>(
id: u64,
contents: &S
) -> Result<Self, Error>

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

fn set_contents<S: SerializedCollection<Contents = S>>(
&mut self,
contents: &S
) -> Result<(), Error>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

impl<'a, C> TryFrom<&'a OwnedDocument> for CollectionDocument<C> where
C: SerializedCollection,

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

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

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

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

impl<T> ToOwned for T where
T: Clone,

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

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

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