Struct bonsaidb_core::document::Header

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

The header of a Document.

Fields

id: DocumentId

The id of the Document. Unique across the collection the document is contained within.

revision: Revision

The revision of the stored 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 AsMut<Header> for OwnedDocument

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

Converts this type into a mutable 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 AsRef<Header> for OwnedDocument

fn as_ref(&self) -> &Header

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

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Header

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

Formats the value using the given formatter.

impl Emit for Header

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 HasHeader for Header

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

Returns the header for this instance.

impl Hash for Header

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 PartialEq for Header

fn eq(&self, other: &Header) -> 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 Serialize for Header

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 Header

where 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 Header

where 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 Eq for Header

impl StructuralEq for Header

impl StructuralPartialEq for Header