Struct bonsaidb_core::schema::CollectionSummary

pub struct CollectionSummary {
    pub name: CollectionName,
    pub primary_key: KeyDescription,
    /* private fields */
}

A summary of a Collection.

Fields

name: CollectionName

The name of the Collection this is a summary of.

primary_key: KeyDescription

The description of Collection::PrimaryKey.

Implementations

impl CollectionSummary

pub fn view(&self, name: &ViewName) -> Option<&ViewSummary>

Returns the summary of the named view, if it is contained in this collection.

pub fn views(&self) -> impl Iterator<Item = &ViewSummary>

Returns an iterator over all summaries of views in this collection.

Trait Implementations

impl Clone for CollectionSummary

fn clone(&self) -> CollectionSummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CollectionSummary

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CollectionSummary

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CollectionSummary

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CollectionSummary

impl StructuralEq for CollectionSummary

impl StructuralPartialEq for CollectionSummary