Struct bonsaidb_core::schema::SchemaSummary

pub struct SchemaSummary {
    pub name: SchemaName,
    /* private fields */
}

A summary of a Schema/Schematic.

This type is a serializable summary of a Schematic and is the result of StorageConnection::list_available_schemas/AsyncStorageConnection::list_available_schemas. It can be used to query information stored in BonsaiDb without needing access to the Rust types.

Fields

name: SchemaName

The name of the Schema this summary is of.

Implementations

impl SchemaSummary

pub fn collection(&self, name: &CollectionName) -> Option<&CollectionSummary>

Returns the summary of named collection, if the schema contains it.

pub fn collections(&self) -> impl Iterator<Item = &CollectionSummary>

Returns an iterator over all collections contained in this schema.

Trait Implementations

impl Clone for SchemaSummary

fn clone(&self) -> SchemaSummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaSummary

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SchemaSummary

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a Schematic> for SchemaSummary

fn from(schematic: &'a Schematic) -> Self

Converts to this type from the input type.

impl PartialEq for SchemaSummary

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

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 SchemaSummary

impl StructuralEq for SchemaSummary

impl StructuralPartialEq for SchemaSummary