Struct ezomyte::Properties

pub struct Properties { /* fields omitted */ }

Container for miscellaneous item properties. These are commonly obtained from the "properties" JSON array in the stash tabs API response.

Most properties have values associated with them (e.g. weapon damage ranges), though some serve as mere "markers" or "tags" (like gem classes: Spell, Support, Minion, etc.).

Methods

impl Properties

pub fn new() -> Self

Create a new property container.

impl Properties

pub fn contains<K: ?Sized>(&self, k: &K) -> bool where
    String: Borrow<K>,
    K: Hash + Eq, 

Checks whether given property exists.

pub fn get_value<'p, K: ?Sized>(&'p self, k: &K) -> Option<&'p String> where
    String: Borrow<K>,
    K: Hash + Eq, 

Retrieve the Value of given property, if it exists and has one.

pub fn is_empty(&self) -> bool

Checks whether the properties container is empty.

Important traits for Box<W>

impl<W> Write for Box<W> where
    W: Write + ?Sized, impl<R> Read for Box<R> where
    R: Read + ?Sized, impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn iter<'p>(
    &'p self
) -> Box<Iterator<Item = (&'p String, Option<&'p String>)> + 'p>

Return an iterator over property keys & optional values as pairs.

Important traits for Box<W>

impl<W> Write for Box<W> where
    W: Write + ?Sized, impl<R> Read for Box<R> where
    R: Read + ?Sized, impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn keys<'p>(&'p self) -> Box<Iterator<Item = &'p String> + 'p>

Return an iterator over property keys (names).

pub fn len(&self) -> usize

Returns the total number of properties (with or without values).

impl Properties

pub fn clear(&mut self)

Clears the container, removing all properties.

pub fn insert(
    &mut self,
    key: String,
    opt_value: Option<String>
) -> Option<Option<String>>

Insert a new property, possibly with a value, into the container.

If opt_value is None, the property will be inserted without any value associated with it.

If the property exists already, its value is updated and the previous one, if any, is returned. This means that in case the property existed before but didn't have a value, the function will return Some(None).

Important traits for Box<W>

impl<W> Write for Box<W> where
    W: Write + ?Sized, impl<R> Read for Box<R> where
    R: Read + ?Sized, impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn iter_mut<'p>(
    &'p mut self
) -> Box<Iterator<Item = (&'p String, Option<&'p mut String>)> + 'p>

Returns an iterator of all over property keys & their optional values.

The type of iterator element is (&Key, Option<&mut Value>). Notice that this doesn't allow to add/remove values associated with properties, but only modify the value if they already have one.

pub fn put(&mut self, key: String) -> Option<Option<String>>

Insert a new, value-less property into the container.

If the property exists already, its value is reset and the previous one, if any, is returned. This means that in case the property existed before but didn't have a value, the function will return Some(None).

If the property didn't exist already, None is returned.

pub fn put_with_value(
    &mut self,
    key: String,
    value: String
) -> Option<Option<String>>

Insert a new property with given value into the container.

If the property exists already, its value is updated and the previous one, if any, is returned. This means that in case the property existed before but didn't have a value, the function will return Some(None).

pub fn remove<K: ?Sized>(&mut self, key: &K) -> Option<Option<String>> where
    String: Borrow<K>,
    K: Hash + Eq, 

Remove a property from the container and return the value associated with it, if any.

If the property didn't exist, this method will return None. Contrast this with the situation where the property existed but didn't have a value associated with it, in which case the return value will be Some(None).

Trait Implementations

impl Default for Properties

fn default() -> Properties

Returns the "default value" for a type.

impl FromIterator<String> for Properties

fn from_iter<T: IntoIterator<Item = String>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<(String, String)> for Properties

fn from_iter<T: IntoIterator<Item = (String, String)>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<(String, Option<String>)> for Properties

fn from_iter<T: IntoIterator<Item = (String, Option<String>)>>(iter: T) -> Self

Creates a value from an iterator.

impl IntoIterator for Properties

type Item = (String, Option<String>)

The type of the elements being iterated over.

type IntoIter = Box<Iterator<Item = Self::Item>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'p> IntoIterator for &'p Properties

type Item = (&'p String, Option<&'p String>)

The type of the elements being iterated over.

type IntoIter = Box<Iterator<Item = Self::Item> + 'p>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Debug for Properties

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Properties

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

Deserialize this value from the given Serde deserializer.