Enum valence::nbt::value::ValueRef

pub enum ValueRef<'a, S = String> {
    Byte(&'a i8),
    Short(&'a i16),
    Int(&'a i32),
    Long(&'a i64),
    Float(&'a f32),
    Double(&'a f64),
    ByteArray(&'a [i8]),
    String(&'a S),
    List(&'a List<S>),
    Compound(&'a Compound<S>),
    IntArray(&'a [i32]),
    LongArray(&'a [i64]),
}

Expand description

Represents a reference to an arbitrary NBT value, where the tag is not part of the reference.

Variants§

Byte(&'a i8)

Short(&'a i16)

Int(&'a i32)

Long(&'a i64)

Float(&'a f32)

Double(&'a f64)

ByteArray(&'a [i8])

String(&'a S)

List(&'a List<S>)

Compound(&'a Compound<S>)

IntArray(&'a [i32])

LongArray(&'a [i64])

Implementations§

impl<'a, S> ValueRef<'a, S>

pub fn tag(&self) -> Tag

Returns the type of this value.

pub fn is_number(&self) -> bool

Returns whether this value is a number, i.e. a byte, short, int, long, float or double.

pub fn as_i8(&self) -> Option<i8>

If this value is a number, returns the i8 representation of this value.

pub fn as_i16(&self) -> Option<i16>

If this value is a number, returns the i16 representation of this value.

pub fn as_i32(&self) -> Option<i32>

If this value is a number, returns the i32 representation of this value.

pub fn as_i64(&self) -> Option<i64>

If this value is a number, returns the i64 representation of this value.

pub fn as_f32(&self) -> Option<f32>

If this value is a number, returns the f32 representation of this value.

pub fn as_f64(&self) -> Option<f64>

If this value is a number, returns the f64 representation of this value.

pub fn as_bool(&self) -> Option<bool>

If this value is a number, returns the bool representation of this value.

impl<S> ValueRef<'_, S>
where S: Clone,

pub fn to_value(&self) -> Value<S>

Clones this value reference to a new owned Value.

Trait Implementations§

impl<'a, S> Clone for ValueRef<'a, S>
where S: Clone,

fn clone(&self) -> ValueRef<'a, 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

impl<'a, S> Debug for ValueRef<'a, S>
where S: Debug,

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

Formats the value using the given formatter. Read more

impl<'a, S> From<&'a [i32]> for ValueRef<'a, S>

fn from(v: &'a [i32]) -> ValueRef<'a, S>

Converts to this type from the input type.

impl<'a, S> From<&'a [i64]> for ValueRef<'a, S>

fn from(v: &'a [i64]) -> ValueRef<'a, S>

Converts to this type from the input type.

impl<'a> From<&'a [i8]> for ValueRef<'a>

fn from(v: &'a [i8]) -> ValueRef<'a>

Converts to this type from the input type.

impl<'a, S> From<&'a Compound<S>> for ValueRef<'a, S>

fn from(v: &'a Compound<S>) -> ValueRef<'a, S>

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<'a, S> From<&'a List<S>> for ValueRef<'a, S>

fn from(v: &'a List<S>) -> ValueRef<'a, S>

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<'a, S> From<&'a Value<S>> for ValueRef<'a, S>

fn from(v: &'a Value<S>) -> ValueRef<'a, S>

Converts to this type from the input type.

impl<S> From<&ValueRef<'_, S>> for Value<S>
where S: Clone,

fn from(v: &ValueRef<'_, S>) -> Value<S>

Converts to this type from the input type.

impl<'a, S> From<&'a f32> for ValueRef<'a, S>

fn from(v: &'a f32) -> ValueRef<'a, S>

Converts to this type from the input type.

impl<'a, S> From<&'a f64> for ValueRef<'a, S>

fn from(v: &'a f64) -> ValueRef<'a, S>

Converts to this type from the input type.

impl<'a, S> From<&'a i16> for ValueRef<'a, S>

fn from(v: &'a i16) -> ValueRef<'a, S>

Converts to this type from the input type.

impl<'a, S> From<&'a i32> for ValueRef<'a, S>

fn from(v: &'a i32) -> ValueRef<'a, S>

Converts to this type from the input type.

impl<'a, S> From<&'a i64> for ValueRef<'a, S>

fn from(v: &'a i64) -> ValueRef<'a, S>

Converts to this type from the input type.

impl<'a, S> From<&'a i8> for ValueRef<'a, S>

fn from(v: &'a i8) -> ValueRef<'a, S>

Converts to this type from the input type.

impl<'a, S> From<ValueMut<'a, S>> for ValueRef<'a, S>

fn from(v: ValueMut<'a, S>) -> ValueRef<'a, S>

Converts to this type from the input type.

impl<S> From<ValueRef<'_, S>> for Value<S>
where S: Clone,

fn from(v: ValueRef<'_, S>) -> Value<S>

Converts to this type from the input type.

impl<'a, S> PartialEq for ValueRef<'a, S>
where S: Ord + Hash,

fn eq(&self, other: &ValueRef<'a, S>) -> bool

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

1.0.0 · source§

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<'a, S> Copy for ValueRef<'a, S>
where S: Copy,

Auto Trait Implementations§

impl<'a, S> Freeze for ValueRef<'a, S>

impl<'a, S> RefUnwindSafe for ValueRef<'a, S>
where S: RefUnwindSafe,

impl<'a, S> Send for ValueRef<'a, S>
where S: Sync,

impl<'a, S> Sync for ValueRef<'a, S>
where S: Sync,

impl<'a, S> Unpin for ValueRef<'a, S>

impl<'a, S> UnwindSafe for ValueRef<'a, S>
where S: RefUnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

unsafe fn clone_to_uninit(&self, dst: *mut T)

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

Performs copy-assignment from self to dst. Read more

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 + Sync + Send>

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

impl<T> From<T> for T

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

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

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.

impl<T> Same for T

type Output = T

Should always be Self

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.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

Uses borrowed data to replace owned data, usually by cloning. 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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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.

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

impl<T> ConditionalSend for T
where T: Send,