Struct CommunityName 

pub struct CommunityName { /* private fields */ }

A community’s name as given, and the canonical name it stands for. See the module docs for which of the two each operation uses, and why.

Implementations

impl CommunityName

pub fn new(given: impl Into<String>) -> Result<Self, CommunityNameError>

The name as written, with its canonical form worked out. Refused only when nothing is left: whether the community exists is the server’s question, answered with the names that do.

pub fn as_given(&self) -> &str

The name exactly as it was given: what serializes, and what a signature over a payload carrying it covers

pub fn canonical(&self) -> &str

The name the community has: what to look up, compare and store

pub fn is_canonical(&self) -> bool

Whether the name was given in its canonical spelling

pub fn into_canonical(self) -> Self

The same name, given canonically: what a signer should sign

Trait Implementations

impl Borrow<str> for CommunityName

By canonical name, consistent with Eq, Hash and Ord, so a map keyed by community name can be indexed with a &str

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for CommunityName

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommunityName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommunityName

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for CommunityName

The name as given: what was asked for, in messages about it

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

Formats the value using the given formatter.

impl Eq for CommunityName

impl FromStr for CommunityName

type Err = CommunityNameError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for CommunityName

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 CommunityName

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for CommunityName

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&str> for CommunityName

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<str> for CommunityName

Against the canonical name: name == "meta-governance" holds for a name given as meta/governance

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for CommunityName

fn partial_cmp(&self, other: &Self) -> 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 CommunityName

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for CommunityName

type Error = CommunityNameError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for CommunityName

type Error = CommunityNameError

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.