Struct bonsaidb::core::document::Header

source · [−]

pub struct Header {
    pub id: u64,
    pub revision: Revision,
}

Expand description

The header of a Document.

Fields

id: u64

The id of the Document. Unique across the collection C

revision: Revision

The revision of the stored document.

Implementations

source

impl Header

source

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

Creates a Map result with an empty key and value.

source

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

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, Value>(
    &self,
    key: K,
    value: Value
) -> Mappings<K, Value> where
    K: for<'a> Key<'a>,

Creates a Map result with a key and value.

Trait Implementations

source

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

source

pub fn as_ref(&self) -> &Header

Performs the conversion.

source

impl<C> AsRef<Header> for CollectionDocument<C> where
C: SerializedCollection,

source

pub fn as_ref(&self) -> &Header

Performs the conversion.

source

impl AsRef<Header> for Header

source

pub fn as_ref(&self) -> &Header

Performs the conversion.

source

impl AsRef<Header> for OwnedDocument

source

pub fn as_ref(&self) -> &Header

Performs the conversion.

source

impl Clone for Header

source

pub fn clone(&self) -> Header

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 Header

source

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

Formats the value using the given formatter. Read more

source

impl<'de> Deserialize<'de> for Header

source

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

Deserialize this value from the given Serde deserializer. Read more

source

impl Display for Header

source

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

Formats the value using the given formatter. Read more

source

impl PartialEq<Header> for Header

source

pub fn eq(&self, other: &Header) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

source

pub fn ne(&self, other: &Header) -> bool

This method tests for !=.

source

impl Serialize for Header

source

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

source

impl Eq for Header

source

impl StructuralEq for Header

source

impl StructuralPartialEq for Header

Auto Trait Implementations

impl RefUnwindSafe for Header

impl Send for Header

impl Sync for Header

impl Unpin for Header

impl UnwindSafe for Header

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<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

pub fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

impl<T> Instrument for T

source

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

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

source

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 T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

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> ToString for T where
T: Display + ?Sized,

source

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom<U> 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<U>>::Error>

Performs the conversion.

source

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

pub fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

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

source

fn with_current_subscriber(self) -> WithDispatch<Self>

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

source

impl<T> CustomApiError for T where
T: Display + Clone + Serialize + for<'de> Deserialize<'de> + Send + Sync + Debug,

source

Struct bonsaidb::core::document::Header

Fields

Implementations

impl Header

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

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

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

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

Trait Implementations

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

pub fn as_ref(&self) -> &Header

impl<C> AsRef<Header> for CollectionDocument<C> where C: SerializedCollection,

pub fn as_ref(&self) -> &Header

impl AsRef<Header> for Header

pub fn as_ref(&self) -> &Header

impl AsRef<Header> for OwnedDocument

pub fn as_ref(&self) -> &Header

impl Clone for Header

pub fn clone(&self) -> Header

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

impl Debug for Header

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

impl<'de> Deserialize<'de> for Header

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

impl Display for Header

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

impl PartialEq<Header> for Header

pub fn eq(&self, other: &Header) -> bool

pub fn ne(&self, other: &Header) -> bool

impl Serialize for Header

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

impl Eq for Header

impl StructuralEq for Header

impl StructuralPartialEq for Header

Auto Trait Implementations

impl RefUnwindSafe for Header

impl Send for Header

impl Sync for Header

impl Unpin for Header

impl UnwindSafe for Header

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<Q, K> Equivalent<K> for Q where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

pub fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

pub unsafe fn drop(ptr: usize)

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> ToString for T where T: Display + ?Sized,

pub default fn to_string(&self) -> String

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<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

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

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

impl<C> AsRef<Header> for CollectionDocument<C> where
C: SerializedCollection,

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

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

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<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

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

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

impl<T> ToString for T where
T: Display + ?Sized,

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

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

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

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

impl<T> CustomApiError for T where
T: Display + Clone + Serialize + for<'de> Deserialize<'de> + Send + Sync + Debug,

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