Struct valence::protocol::Ident

source ·
pub struct Ident<S> { /* private fields */ }
Expand description

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§

source§

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

source

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

source§

impl<S> Ident<S>

source

pub fn as_str(&self) -> &str
where S: AsRef<str>,

source

pub fn as_str_ident(&self) -> Ident<&str>
where S: AsRef<str>,

source

pub fn to_string_ident(&self) -> Ident<String>
where S: AsRef<str>,

source

pub fn into_inner(self) -> S

source

pub fn namespace(&self) -> &str
where S: AsRef<str>,

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

source

pub fn path(&self) -> &str
where S: AsRef<str>,

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

source

pub fn namespace_and_path(&self) -> (&str, &str)
where S: AsRef<str>,

source§

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

source

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

Trait Implementations§

source§

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

source§

fn as_ref(&self) -> &S

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

impl<S> AsRef<str> for Ident<S>
where S: AsRef<str>,

source§

fn as_ref(&self) -> &str

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

impl<S> Borrow<str> for Ident<S>
where S: Borrow<str>,

source§

fn borrow(&self) -> &str

Immutably borrows from an owned value. Read more
source§

impl<S> Clone for Ident<S>
where S: Clone,

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<S> Debug for Ident<S>
where S: Debug,

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Reads this object from the provided byte slice. Read more
source§

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

source§

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. Read more
source§

impl<S> Display for Ident<S>
where S: Display,

source§

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

Formats the value using the given formatter. Read more
source§

impl<S> Encode for Ident<S>
where S: Encode,

source§

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

Writes this object to the provided writer. Read more
source§

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. Read more
source§

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

source§

fn from(v: &'a Ident<String>) -> ValueRef<'a>

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

impl From<Ident<&str>> for String

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

impl<I, S> From<Ident<I>> for Value<S>
where I: Into<Value<S>>,

source§

fn from(value: Ident<I>) -> Value<S>

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

impl From<Ident<String>> for String

source§

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

Converts to this type from the input type.
source§

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

§

type Err = IdentError

The associated error which can be returned from parsing.
source§

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. Read more
source§

impl FromStr for Ident<String>

§

type Err = IdentError

The associated error which can be returned from parsing.
source§

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

Parses a string s to return a value of this type. Read more
source§

impl<S> Hash for Ident<S>
where S: Hash,

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'a, I, V> Index<Ident<&'a str>> for Registry<I, V>
where I: RegistryIdx,

§

type Output = V

The returned type after indexing.
source§

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

Performs the indexing (container[index]) operation. Read more
source§

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

source§

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. Read more
source§

impl<S> Ord for Ident<S>
where S: Ord,

source§

fn cmp(&self, other: &Ident<S>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl<S, T> PartialEq<Ident<T>> for Ident<S>
where S: PartialEq<T>,

source§

fn eq(&self, other: &Ident<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl<S, T> PartialOrd<Ident<T>> for Ident<S>
where S: PartialOrd<T>,

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl<T> Serialize for Ident<T>
where T: Serialize,

source§

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. Read more
source§

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

§

type Error = IdentError

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = IdentError

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = IdentError

The type returned in the event of a conversion error.
source§

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.
source§

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

§

type Error = IdentError

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = IdentError

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl TryFrom<String> for Ident<String>

§

type Error = IdentError

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<S> Copy for Ident<S>
where S: Copy,

source§

impl<S> Eq for Ident<S>
where S: Eq,

source§

impl<S> StructuralEq for Ident<S>

Auto Trait Implementations§

§

impl<S> RefUnwindSafe for Ident<S>
where S: RefUnwindSafe,

§

impl<S> Send for Ident<S>
where S: Send,

§

impl<S> Sync for Ident<S>
where S: Sync,

§

impl<S> Unpin for Ident<S>
where S: Unpin,

§

impl<S> UnwindSafe for Ident<S>
where S: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
§

impl<T> DynEq for T
where T: Any + Eq,

§

fn as_any(&self) -> &(dyn Any + 'static)

Casts the type to dyn Any.
§

fn dyn_eq(&self, other: &(dyn DynEq + 'static)) -> bool

This method tests for self and other values to be equal. Read more
§

impl<T> DynHash for T
where T: DynEq + Hash,

§

fn as_dyn_eq(&self) -> &(dyn DynEq + 'static)

Casts the type to dyn Any.
§

fn dyn_hash(&self, state: &mut dyn Hasher)

Feeds this value into the given Hasher.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> Serialize for T
where T: Serialize + ?Sized,

source§

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<Ok, Error>

§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> ToSmolStr for T
where T: Display + ?Sized,

§

fn to_smolstr(&self) -> SmolStr

source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> TypeData for T
where T: 'static + Send + Sync + Clone,

§

fn clone_type_data(&self) -> Box<dyn TypeData>

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

source§

impl<N> NodeTrait for N
where N: Copy + Ord + Hash,