Struct valence::ident::Ident

pub struct Ident { /* private fields */ }

An identifier is a string split into a “namespace” part and a “path” part. For instance minecraft:apple and apple are both valid identifiers.

If the namespace part is left off (the part before and including the colon) the namespace is considered to be “minecraft” for the purposes of equality.

A string must match the regex ^([a-z0-9_-]+:)?[a-z0-9_\/.-]+$ to be a valid identifier.

Implementations

impl Ident

pub fn new(str: impl Into<Cow<'static, str>>) -> Result<Ident, ParseError>

Parses a new identifier from a string.

An error is returned if the string is not a valid identifier.

pub fn namespace(&self) -> Option<&str>

Returns the namespace part of this namespaced identifier.

If this identifier was constructed from a string without a namespace, then None is returned.

pub fn path(&self) -> &str

Returns the path part of this namespaced identifier.

pub fn as_str(&self) -> &str

Returns the original string as a str.

Trait Implementations

impl AsRef<str> for Ident

fn as_ref(&self) -> &str

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

impl Clone for Ident

fn clone(&self) -> Ident

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ident

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

Formats the value using the given formatter.

impl Decode for Ident

fn decode(r: &mut impl Read) -> Result<Self>

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

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

Deserialize this value from the given Serde deserializer.

impl Display for Ident

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

Formats the value using the given formatter.

impl Encode for Ident

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

This function must be pure. In other words, consecutive calls to encode must write the exact same sequence of bytes.

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

fn from(id: Ident) -> Self

Converts to this type from the input type.

impl From<Ident> for String

fn from(id: Ident) -> Self

Converts to this type from the input type.

impl FromStr for Ident

type Err = ParseError

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 Ident

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<Ident> for Ident

Equality for identifiers respects the fact that “minecraft:apple” and “apple” have the same meaning.

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

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

Serialize this value into the given Serde serializer.

impl TryFrom<&'static str> for Ident

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(value: &'static str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for Ident

type Error = ParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for Ident

impl StructuralEq for Ident