Struct bonsaidb_core::document::CollectionHeader

pub struct CollectionHeader<PrimaryKey> {
    pub id: PrimaryKey,
    pub revision: Revision,
}

A header for a CollectionDocument.

Fields

id: PrimaryKey

The unique id of the document.

revision: Revision

The revision of the document.

Trait Implementations

impl<PrimaryKey: Clone> Clone for CollectionHeader<PrimaryKey>

fn clone(&self) -> CollectionHeader<PrimaryKey>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<PrimaryKey: Debug> Debug for CollectionHeader<PrimaryKey>

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

Formats the value using the given formatter.

impl<'de, PrimaryKey> Deserialize<'de> for CollectionHeader<PrimaryKey>where PrimaryKey: Deserialize<'de>,

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

Deserialize this value from the given Serde deserializer.

impl<PrimaryKey> Emit for CollectionHeader<PrimaryKey>where PrimaryKey: for<'k> Key<'k>,

fn emit_key_and_value<K, Value>( &self, key: K, value: Value ) -> Result<Mappings<K, Value>, Error>

Creates a Map result with a key and value.

fn emit(&self) -> Result<Mappings<(), ()>, Error>

Creates a Map result with an empty key and value.

fn emit_if(&self, condition: bool) -> Result<Mappings<(), ()>, Error>

Creates a Map result with an empty key and value if condition is true.

fn emit_key<K>(&self, key: K) -> Result<Mappings<K, ()>, Error>

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

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

Creates a Map result with value and an empty key.

impl<PrimaryKey> HasHeader for CollectionHeader<PrimaryKey>where PrimaryKey: for<'k> Key<'k>,

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

Returns the header for this instance.

impl<PrimaryKey: Hash> Hash for CollectionHeader<PrimaryKey>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<PrimaryKey: PartialEq> PartialEq<CollectionHeader<PrimaryKey>> for CollectionHeader<PrimaryKey>

fn eq(&self, other: &CollectionHeader<PrimaryKey>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<PrimaryKey> Serialize for CollectionHeader<PrimaryKey>where PrimaryKey: Serialize,

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

Serialize this value into the given Serde serializer.

impl<'a, PrimaryKey> TryFrom<&'a CollectionHeader<PrimaryKey>> for Headerwhere PrimaryKey: for<'k> Key<'k>,

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a, PrimaryKey> TryFrom<&'a Header> for CollectionHeader<PrimaryKey>where PrimaryKey: for<'k> Key<'k>,

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<PrimaryKey> TryFrom<CollectionHeader<PrimaryKey>> for Headerwhere PrimaryKey: for<'k> Key<'k>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: CollectionHeader<PrimaryKey>) -> Result<Self, Self::Error>

Performs the conversion.

impl<PrimaryKey> TryFrom<Header> for CollectionHeader<PrimaryKey>where PrimaryKey: for<'k> Key<'k>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Header) -> Result<Self, Self::Error>

Performs the conversion.

impl<PrimaryKey: Copy> Copy for CollectionHeader<PrimaryKey>

impl<PrimaryKey: Eq> Eq for CollectionHeader<PrimaryKey>

impl<PrimaryKey> StructuralEq for CollectionHeader<PrimaryKey>

impl<PrimaryKey> StructuralPartialEq for CollectionHeader<PrimaryKey>