Struct valence::nbt::compound::Compound

pub struct Compound<S = String> { /* private fields */ }

A map type with String keys and Value values.

Implementations

impl<S> Compound<S>

pub fn new() -> Compound<S>

pub fn with_capacity(cap: usize) -> Compound<S>

pub fn clear(&mut self)

impl<S> Compound<S>

where S: Ord + Hash,

pub fn get<Q>(&self, k: &Q) -> Option<&Value<S>>

where Q: AsBorrowed<S> + ?Sized, <Q as AsBorrowed<S>>::Borrowed: Hash + Ord, S: Borrow<<Q as AsBorrowed<S>>::Borrowed>,

pub fn contains_key<Q>(&self, k: &Q) -> bool

where Q: AsBorrowed<S> + ?Sized, <Q as AsBorrowed<S>>::Borrowed: Hash + Ord, S: Borrow<<Q as AsBorrowed<S>>::Borrowed>,

pub fn get_mut<Q>(&mut self, k: &Q) -> Option<&mut Value<S>>

where Q: AsBorrowed<S> + ?Sized, <Q as AsBorrowed<S>>::Borrowed: Hash + Ord, S: Borrow<<Q as AsBorrowed<S>>::Borrowed>,

pub fn get_key_value<Q>(&self, k: &Q) -> Option<(&S, &Value<S>)>

where Q: AsBorrowed<S> + ?Sized, <Q as AsBorrowed<S>>::Borrowed: Hash + Ord, S: Borrow<<Q as AsBorrowed<S>>::Borrowed>,

pub fn insert<K, V>(&mut self, k: K, v: V) -> Option<Value<S>>

where K: Into<S>, V: Into<Value<S>>,

pub fn remove<Q>(&mut self, k: &Q) -> Option<Value<S>>

where Q: AsBorrowed<S> + ?Sized, <Q as AsBorrowed<S>>::Borrowed: Hash + Ord, S: Borrow<<Q as AsBorrowed<S>>::Borrowed>,

pub fn swap_remove<Q>(&mut self, k: &Q) -> Option<Value<S>>

where Q: AsBorrowed<S> + ?Sized, <Q as AsBorrowed<S>>::Borrowed: Hash + Ord, S: Borrow<<Q as AsBorrowed<S>>::Borrowed>,

pub fn shift_remove<Q>(&mut self, k: &Q) -> Option<Value<S>>

where Q: AsBorrowed<S> + ?Sized, <Q as AsBorrowed<S>>::Borrowed: Hash + Ord, S: Borrow<<Q as AsBorrowed<S>>::Borrowed>,

pub fn remove_entry<Q>(&mut self, k: &Q) -> Option<(S, Value<S>)>

where S: Borrow<Q>, Q: Ord + Hash + ?Sized,

pub fn swap_remove_entry<Q>(&mut self, k: &Q) -> Option<(S, Value<S>)>

where S: Borrow<Q>, Q: Ord + Hash + ?Sized,

pub fn shift_remove_entry<Q>(&mut self, k: &Q) -> Option<(S, Value<S>)>

where S: Borrow<Q>, Q: Ord + Hash + ?Sized,

pub fn append(&mut self, other: &mut Compound<S>)

pub fn entry<K>(&mut self, k: K) -> Entry<'_, S>

where K: Into<S>,

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn iter(&self) -> Iter<'_, S>

pub fn iter_mut(&mut self) -> IterMut<'_, S>

pub fn keys(&self) -> Keys<'_, S>

pub fn values(&self) -> Values<'_, S>

pub fn values_mut(&mut self) -> ValuesMut<'_, S>

pub fn retain<F>(&mut self, f: F)

where F: FnMut(&S, &mut Value<S>) -> bool,

pub fn merge(&mut self, other: Compound<S>)

Inserts all items from other into self recursively.

Example

use valence_nbt::compound;

let mut this = compound! {
    "foo" => 10,
    "bar" => compound! {
        "baz" => 20,
    }
};

let other = compound! {
    "foo" => 15,
    "bar" => compound! {
        "quux" => "hello",
    }
};

this.merge(other);

assert_eq!(
    this,
    compound! {
        "foo" => 15,
        "bar" => compound! {
            "baz" => 20,
            "quux" => "hello",
        }
    }
);

Trait Implementations

impl<S> Clone for Compound<S>

where S: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Debug for Compound<S>

where S: Debug,

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

Formats the value using the given formatter.

impl Decode<'_> for Compound

fn decode(r: &mut &[u8]) -> Result<Compound, Error>

Reads this object from the provided byte slice.

impl<S> Default for Compound<S>

where S: Default,

fn default() -> Compound<S>

Returns the “default value” for a type.

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

where S: Ord + Hash + Deserialize<'de>,

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'de> Deserializer<'de> for Compound

type Error = Error

The error type that can be returned if some error occurs during deserialization.

fn deserialize_any<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Require the Deserializer to figure out how to drive the visitor based on what data type is in the input.

fn deserialize_bool<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a bool value.

fn deserialize_i8<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i8 value.

fn deserialize_i16<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i16 value.

fn deserialize_i32<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i32 value.

fn deserialize_i64<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i64 value.

fn deserialize_i128<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i128 value.

fn deserialize_u8<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u8 value.

fn deserialize_u16<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u16 value.

fn deserialize_u32<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u32 value.

fn deserialize_u64<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u64 value.

fn deserialize_u128<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an u128 value.

fn deserialize_f32<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a f32 value.

fn deserialize_f64<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a f64 value.

fn deserialize_char<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a char value.

fn deserialize_str<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a string value and does not benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_string<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a string value and would benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_bytes<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a byte array and does not benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_byte_buf<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a byte array and would benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_option<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an optional value.

fn deserialize_unit<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a unit value.

fn deserialize_unit_struct<V>( self, name: &'static str, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a unit struct with a particular name.

fn deserialize_newtype_struct<V>( self, name: &'static str, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a newtype struct with a particular name.

fn deserialize_seq<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a sequence of values.

fn deserialize_tuple<V>( self, len: usize, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a sequence of values and knows how many values there are without looking at the serialized data.

fn deserialize_tuple_struct<V>( self, name: &'static str, len: usize, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a tuple struct with a particular name and number of fields.

fn deserialize_map<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a map of key-value pairs.

fn deserialize_struct<V>( self, name: &'static str, fields: &'static [&'static str], visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a struct with a particular name and fields.

fn deserialize_enum<V>( self, name: &'static str, variants: &'static [&'static str], visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an enum value with a particular name and possible variants.

fn deserialize_identifier<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting the name of a struct field or the discriminant of an enum variant.

fn deserialize_ignored_any<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <Compound as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type needs to deserialize a value whose type doesn’t matter because it is ignored.

fn is_human_readable(&self) -> bool

Determine whether Deserialize implementations should expect to deserialize their human-readable form.

impl Encode for Compound

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<S> Extend<(S, Value<S>)> for Compound<S>

where S: Ord + Hash,

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = (S, Value<S>)>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

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, S> From<&'a mut Compound<S>> for ValueMut<'a, S>

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

Converts to this type from the input type.

impl<S> From<Compound<S>> for Value<S>

fn from(v: Compound<S>) -> Value<S>

Converts to this type from the input type.

impl<S> FromIterator<(S, Value<S>)> for Compound<S>

where S: Ord + Hash,

fn from_iter<T>(iter: T) -> Compound<S>

where T: IntoIterator<Item = (S, Value<S>)>,

Creates a value from an iterator.

impl<S, Q> Index<&Q> for Compound<S>

where S: Borrow<Q> + Ord + Hash, Q: Ord + Hash + ?Sized,

type Output = Value<S>

The returned type after indexing.

fn index(&self, index: &Q) -> &<Compound<S> as Index<&Q>>::Output

Performs the indexing (container[index]) operation.

impl<S, Q> IndexMut<&Q> for Compound<S>

where S: Borrow<Q> + Hash + Ord, Q: Ord + Hash + ?Sized,

fn index_mut(&mut self, index: &Q) -> &mut <Compound<S> as Index<&Q>>::Output

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

impl<'de> IntoDeserializer<'de, Error> for Compound

type Deserializer = Compound

The type of the deserializer being converted into.

fn into_deserializer( self, ) -> <Compound as IntoDeserializer<'de, Error>>::Deserializer

Convert this value into a deserializer.

impl<'a, S> IntoIterator for &'a Compound<S>

type Item = (&'a S, &'a Value<S>)

The type of the elements being iterated over.

type IntoIter = Iter<'a, S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a Compound<S> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a, S> IntoIterator for &'a mut Compound<S>

type Item = (&'a S, &'a mut Value<S>)

The type of the elements being iterated over.

type IntoIter = IterMut<'a, S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a mut Compound<S> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<S> IntoIterator for Compound<S>

type Item = (S, Value<S>)

The type of the elements being iterated over.

type IntoIter = IntoIter<S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Compound<S> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<S> PartialEq for Compound<S>

where S: Ord + Hash,

fn eq(&self, other: &Compound<S>) -> 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<Str> Serialize for Compound<Str>

where Str: Ord + Hash + 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.