Struct bonsaidb_core::document::CollectionHeader

source · [−]

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

Expand description

A header for a CollectionDocument.

Fields

id: PrimaryKey

The unique id of the document.

revision: Revision

The revision of the document.

Trait Implementations

source

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

source

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

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<PrimaryKey: Debug> Debug for CollectionHeader<PrimaryKey>

source

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

Formats the value using the given formatter. Read more

source

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

source

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

Creates a Map result with a key and value.

source

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

Creates a Map result with an empty key and value.

source

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

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

source

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

Creates a Map result with value and an empty key.

source

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

Returns the header for this instance.

source

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

source

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

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

source

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

This method tests for !=.

source

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.

source

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

Performs the conversion.

source

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.

source

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

Performs the conversion.

source

impl<PrimaryKey> StructuralPartialEq for CollectionHeader<PrimaryKey>

Auto Trait Implementations

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

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

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

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

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

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

Returns the argument unchanged.

source

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

const: unstable · source

pub 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<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.

Struct bonsaidb_core::document::CollectionHeader

Fields

Trait Implementations

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

type Error = Error

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

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

type Error = Error

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

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>

Auto Trait Implementations

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

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

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

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

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

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<PrimaryKey> Emit for CollectionHeader<PrimaryKey> where
PrimaryKey: for<'k> Key<'k>,

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

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

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

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

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

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

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

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

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

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>,