Struct valence::protocol::Ident

pub struct Ident<S> { /* private fields */ }

A wrapper around a string type S which guarantees the wrapped string is a valid resource identifier.

A resource identifier is a string divided into a “namespace” part and a “path” part. For instance minecraft:apple and valence:frobnicator are both valid identifiers. A string must match the regex ^([a-z0-9_.-]+:)?[a-z0-9_.-\/]+$ to be successfully parsed.

While parsing, if the namespace part is left off (the part before and including the colon) then “minecraft:” is inserted at the beginning of the string.

Implementations

impl<'a> Ident<Cow<'a, str>>

pub fn new<S>(string: S) -> Result<Ident<Cow<'a, str>>, IdentError>

where S: Into<Cow<'a, str>>,

impl<S> Ident<S>

pub fn as_str(&self) -> &str

where S: AsRef<str>,

pub fn as_str_ident(&self) -> Ident<&str>

where S: AsRef<str>,

pub fn to_string_ident(&self) -> Ident<String>

where S: AsRef<str>,

pub fn into_inner(self) -> S

pub fn namespace(&self) -> &str

where S: AsRef<str>,

Returns the namespace part of this resource identifier (the part before the colon).

pub fn path(&self) -> &str

where S: AsRef<str>,

Returns the path part of this resource identifier (the part after the colon).

pub fn namespace_and_path(&self) -> (&str, &str)

where S: AsRef<str>,

impl<'a> Ident<Cow<'a, str>>

pub fn borrowed(&self) -> Ident<Cow<'_, str>>

Trait Implementations

impl<S> AsRef<S> for Ident<S>

fn as_ref(&self) -> &S

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

impl<S> AsRef<str> for Ident<S>

where S: AsRef<str>,

fn as_ref(&self) -> &str

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

impl<S> Borrow<str> for Ident<S>

where S: Borrow<str>,

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<S> Clone for Ident<S>

where S: Clone,

fn clone(&self) -> Ident<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Debug for Ident<S>

where S: Debug,

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

Formats the value using the given formatter.

impl<'a, S> Decode<'a> for Ident<S>

where S: Decode<'a>, Ident<S>: TryFrom<S, Error = IdentError>,

fn decode(r: &mut &'a [u8]) -> Result<Ident<S>, Error>

Reads this object from the provided byte slice.

impl<'de, S> Deserialize<'de> for Ident<S>

where S: Deserialize<'de>, Ident<S>: TryFrom<S, Error = IdentError>,

fn deserialize<D>( deserializer: D, ) -> Result<Ident<S>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S> Display for Ident<S>

where S: Display,

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

Formats the value using the given formatter.

impl<S> Encode for Ident<S>

where S: Encode,

fn encode(&self, w: impl Write) -> Result<(), Error>

Writes this object to the provided writer.

fn encode_slice(slice: &[Self], w: impl Write) -> Result<(), Error>

where Self: Sized,

Like Encode::encode, except that a whole slice of values is encoded.

impl<'a> From<Ident<&'a str>> for Ident<Cow<'a, str>>

fn from(value: Ident<&'a str>) -> Ident<Cow<'a, str>>

Converts to this type from the input type.

impl<'a> From<Ident<&'a str>> for Ident<String>

fn from(value: Ident<&'a str>) -> Ident<String>

Converts to this type from the input type.

impl From<Ident<&str>> for String

fn from(value: Ident<&str>) -> String

Converts to this type from the input type.

impl<'a> From<Ident<Cow<'a, str>>> for Cow<'a, str>

fn from(value: Ident<Cow<'a, str>>) -> Cow<'a, str>

Converts to this type from the input type.

impl<'a> From<Ident<Cow<'a, str>>> for Ident<String>

fn from(value: Ident<Cow<'a, str>>) -> Ident<String>

Converts to this type from the input type.

impl<'a> From<Ident<String>> for Ident<Cow<'a, str>>

fn from(value: Ident<String>) -> Ident<Cow<'a, str>>

Converts to this type from the input type.

impl From<Ident<String>> for String

fn from(value: Ident<String>) -> String

Converts to this type from the input type.

impl FromStr for Ident<Cow<'static, str>>

type Err = IdentError

The associated error which can be returned from parsing.

fn from_str( s: &str, ) -> Result<Ident<Cow<'static, str>>, <Ident<Cow<'static, str>> as FromStr>::Err>

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

impl FromStr for Ident<String>

type Err = IdentError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Ident<String>, <Ident<String> as FromStr>::Err>

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

impl<S> Hash for Ident<S>

where S: Hash,

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<'a, I, V> Index<Ident<&'a str>> for Registry<I, V>

where I: RegistryIdx,

type Output = V

The returned type after indexing.

fn index( &self, index: Ident<&'a str>, ) -> &<Registry<I, V> as Index<Ident<&'a str>>>::Output

Performs the indexing (container[index]) operation.

impl<'a, I, V> IndexMut<Ident<&'a str>> for Registry<I, V>

where I: RegistryIdx,

fn index_mut( &mut self, index: Ident<&'a str>, ) -> &mut <Registry<I, V> as Index<Ident<&'a str>>>::Output

Performs the mutable indexing (container[index]) operation.

impl<S> Ord for Ident<S>

where S: Ord,

fn cmp(&self, other: &Ident<S>) -> 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<S, T> PartialEq<Ident<T>> for Ident<S>

where S: PartialEq<T>,

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

where S: PartialOrd<T>,

fn partial_cmp(&self, other: &Ident<T>) -> 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<T> Serialize for Ident<T>

where T: Serialize,

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<'a> TryFrom<&'a str> for Ident<Cow<'a, str>>

type Error = IdentError

The type returned in the event of a conversion error.

fn try_from( value: &'a str, ) -> Result<Ident<Cow<'a, str>>, <Ident<Cow<'a, str>> as TryFrom<&'a str>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a str> for Ident<String>

type Error = IdentError

The type returned in the event of a conversion error.

fn try_from( value: &'a str, ) -> Result<Ident<String>, <Ident<String> as TryFrom<&'a str>>::Error>

Performs the conversion.

impl<'a> TryFrom<Cow<'a, str>> for Ident<Cow<'a, str>>

type Error = IdentError

The type returned in the event of a conversion error.

fn try_from( value: Cow<'a, str>, ) -> Result<Ident<Cow<'a, str>>, <Ident<Cow<'a, str>> as TryFrom<Cow<'a, str>>>::Error>

Performs the conversion.

impl<'a> TryFrom<Cow<'a, str>> for Ident<String>

type Error = IdentError

The type returned in the event of a conversion error.

fn try_from( value: Cow<'a, str>, ) -> Result<Ident<String>, <Ident<String> as TryFrom<Cow<'a, str>>>::Error>

Performs the conversion.

impl<'a> TryFrom<String> for Ident<Cow<'a, str>>

type Error = IdentError

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<Ident<Cow<'a, str>>, <Ident<Cow<'a, str>> as TryFrom<String>>::Error>

Performs the conversion.

impl TryFrom<String> for Ident<String>

type Error = IdentError

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<Ident<String>, <Ident<String> as TryFrom<String>>::Error>

Performs the conversion.

impl<S> Copy for Ident<S>

where S: Copy,

impl<S> Eq for Ident<S>

where S: Eq,