Struct gardiz::map::Map

pub struct Map<K, V>where
    K: Ord,{ /* private fields */ }

Map of coordinates in a plane to arbitrary data. Optimized given the fact the coordinates/vectors are in the plane. Keys of the map are Vec2<K>.

Implementations

impl<K, V> Map<K, V>where K: Ord,

pub fn new() -> Self

Creates a new empty coordinate map.

pub fn is_empty(&self) -> bool

Returns whether the map is empty.

pub fn len(&self) -> usize

Returns the length of the map, i.e. how many Vec2 (keys) are stored in this map.

pub fn get<Q>(&self, point: Vec2<&Q>) -> Option<&V>where K: Borrow<Q>, Q: Ord,

Attempts to get the data associated with the given point.

pub fn contains<Q>(&self, point: Vec2<&Q>) -> boolwhere K: Borrow<Q>, Q: Ord,

Tests if the map contains the given point.

pub fn neighbours<Q>( &self, point: Vec2<&Q>, direction: Direction ) -> Neighbours<'_, K, V> where K: Borrow<Q>, Q: Ord,

Returns an iterator to the neighbours of a given point in a straight line in the given direction. The starting point is NOT included. For every point yielded by the iterator, the associated data is also returned.

pub fn neighbours_incl<Q>( &self, point: Vec2<&Q>, direction: Direction ) -> Neighbours<'_, K, V> where K: Borrow<Q>, Q: Ord,

Returns an iterator to the neighbours of a given point in a straight line in the given direction. The starting point IS included. For every point yielded by the iterator, the associated data is also returned.

pub fn first_neighbour<Q>( &self, point: Vec2<&Q>, direction: Direction ) -> Option<Vec2<&K>>where K: Borrow<Q>, Q: Ord,

Returns the nearest neighbour in a straight line of a given point in the the given direction WITHOUT the associated data.

pub fn first_neighbour_data<Q>( &self, point: Vec2<&Q>, direction: Direction ) -> Option<(Vec2<&K>, &V)>where K: Borrow<Q>, Q: Ord,

Returns the nearest neighbour in a straight line of a given point in the given direction WITH the associated data.

pub fn last_neighbour<Q>( &self, point: Vec2<&Q>, direction: Direction ) -> Option<Vec2<&K>>where K: Borrow<Q>, Q: Ord,

Returns the furthest neighbour in a straight line of a given point in the given direction WITHOUT the associated data.

pub fn last_neighbour_data<Q>( &self, point: Vec2<&Q>, direction: Direction ) -> Option<(Vec2<&K>, &V)>where K: Borrow<Q>, Q: Ord,

Returns the furthest neighbour in a straight line of a given point in the given direction WITH the associated data.

pub fn insert(&mut self, point: Vec2<K>, value: V) -> Option<V>where K: Clone, V: Clone,

Inserts the given point with its associated data. A possible previous value is returned.

pub fn create(&mut self, point: Vec2<K>, value: V) -> boolwhere K: Clone, V: Clone,

Creates an entry at the given point with its associated data. Fails if there already is an entry for that point. Returns whether it succeeded.

pub fn update<Q>(&mut self, point: Vec2<&Q>, value: V) -> Result<V, V>where K: Borrow<Q>, Q: Ord, V: Clone,

Updates an existing point’s entry with the given value. The entry must exist. Returns Ok(old_value) if successful, but Err(attempted_value) if failing.

pub fn remove<Q>(&mut self, point: Vec2<&Q>) -> Option<V>where K: Borrow<Q>, Q: Ord,

Removes the given point entry from the from the map. Returns the data associated with the point, if successful.

pub fn rows(&self) -> Rows<'_, K, V>

Returns an iterator over all entries, by running through the “rows” of the map, (with the first entries having the lowest keys), i.e. all X are yielded before going to the next Y.

pub fn columns(&self) -> Columns<'_, K, V>

Returns an iterator over all entries, by running through the “columns” of the map, (with the first entries having the lowest keys), i.e. all Y are yielded before going to the next X.

Trait Implementations

impl<K, V: Clone> Clone for Map<K, V>where K: Ord + Clone,

fn clone(&self) -> Map<K, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K, V: Debug> Debug for Map<K, V>where K: Ord + Debug,

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

Formats the value using the given formatter.

impl<K, V> Default for Map<K, V>where K: Ord,

fn default() -> Self

Returns the “default value” for a type.

impl<'de, K, V> Deserialize<'de> for Map<K, V>where K: Deserialize<'de> + Ord + Clone, V: Deserialize<'de> + Clone,

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

Deserialize this value from the given Serde deserializer.

impl<K, V> Extend<(Vec2<K>, V)> for Map<K, V>where K: Ord + Clone, V: Clone,

fn extend<I>(&mut self, iter: I)where I: IntoIterator<Item = (Vec2<K>, V)>,

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<K, V> FromIterator<(Vec2<K>, V)> for Map<K, V>where K: Ord + Clone, V: Clone,

fn from_iter<I>(iter: I) -> Selfwhere I: IntoIterator<Item = (Vec2<K>, V)>,

Creates a value from an iterator.

impl<K, V> PartialEq<Map<K, V>> for Map<K, V>where K: Ord, V: PartialEq,

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<K, V> Serialize for Map<K, V>where K: Serialize + Ord, V: Serialize,

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

Serialize this value into the given Serde serializer.

impl<K, V> Eq for Map<K, V>where K: Ord, V: Eq,