Struct bonsaidb_core::schema::CollectionName

pub struct CollectionName {
    pub authority: Authority,
    pub name: Name,
}

The namespaced name of a Collection.

Fields

authority: Authority

The authority of this collection. This name is used to ensure collections from multiple authors/authorities can be used in the same schema.

name: Name

The name of this collection. Must be unique within the Schema

Implementations

impl CollectionName

pub fn private<N: Into<Name>>(name: N) -> Self

Creates a name for a Collection that is not meant to be shared with other developers.

pub fn new<A: Into<Authority>, N: Into<Name>>(authority: A, name: N) -> Self

Creates a new collection name.

pub fn parse_encoded(collection_name: &str) -> Result<Self, InvalidNameError>

Parses a colleciton name that was previously encoded via Self::encoded().

Errors

Returns InvalidNameError if the name contains invalid escape sequences or contains more than two periods.

pub fn encoded(&self) -> String

Encodes this collection name such that the authority and name can be safely parsed using Self::parse_encoded.

Trait Implementations

impl Clone for CollectionName

fn clone(&self) -> CollectionName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CollectionName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CollectionName

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

Deserialize this value from the given Serde deserializer.

impl Display for CollectionName

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

Formats the value using the given formatter.

impl Hash for CollectionName

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<CollectionName> for CollectionName

fn eq(&self, other: &CollectionName) -> bool

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

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

This method tests for !=.

impl Serialize for CollectionName

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 CollectionName

impl StructuralEq for CollectionName

impl StructuralPartialEq for CollectionName