Struct bonsaidb::core::schema::Name

pub struct Name { /* private fields */ }

A schema name. Cloning is inexpensive.

Implementations

impl Name

pub fn new<T>(contents: T) -> Name

where T: Into<Name>,

Creates a new name.

pub fn parse_encoded(encoded: &str) -> Result<Name, InvalidNameError>

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

Errors

Returns InvalidNameError if the name contains invalid escape sequences.

pub fn encoded(&self) -> String

Returns an encoded version of this name that contains only alphanumeric ASCII, underscore, and hyphen.

Trait Implementations

impl AsRef<str> for Name

fn as_ref(&self) -> &str

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

impl Clone for Name

fn clone(&self) -> Name

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Name

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Name

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Name

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

Formats the value using the given formatter.

impl From<&'static str> for Name

fn from(value: &'static str) -> Name

Converts to this type from the input type.

impl From<Cow<'static, str>> for Name

fn from(value: Cow<'static, str>) -> Name

Converts to this type from the input type.

impl From<Name> for Authority

fn from(value: Name) -> Authority

Converts to this type from the input type.

impl From<String> for Name

fn from(value: String) -> Name

Converts to this type from the input type.

impl Hash for Name

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 Into<String> for Name

fn into(self) -> String

Converts this type into the (usually inferred) input type.

impl Ord for Name

fn cmp(&self, other: &Name) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Name

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

fn partial_cmp(&self, other: &Name) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Name

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Name

impl StructuralEq for Name

impl StructuralPartialEq for Name