Struct TopologyName 

pub struct TopologyName(/* private fields */);

A strongly-typed topology name.

This newtype wrapper ensures topology names cannot be confused with other string types like region names.

Example

use chroma_types::TopologyName;

let name = TopologyName::new("global").unwrap();
assert_eq!(name.as_str(), "global");

Implementations

impl TopologyName

pub fn new(name: impl Into<String>) -> Result<Self, NameError>

Creates a new topology name.

Errors

Returns a NameError if the name:

• Is empty
• Exceeds 32 characters
• Contains non-ASCII characters

pub fn as_str(&self) -> &str

Returns the topology name as a string slice.

Trait Implementations

impl Clone for TopologyName

fn clone(&self) -> TopologyName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TopologyName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TopologyName

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TopologyName

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

Formats the value using the given formatter.

impl Hash for TopologyName

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TopologyName

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

Restrict a value to a certain interval.

impl PartialEq for TopologyName

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for TopologyName

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for TopologyName

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 TopologyName

impl StructuralPartialEq for TopologyName