Struct nannou::ui::image::Map
[−]
[src]
pub struct Map<Img> { pub trigger_redraw: Cell<bool>, // some fields omitted }
A type used to map the widget::Id
of Image
widgets to their associated Img
data.
The image::Map
type is usually instantiated and loaded during the "setup" stage of the
application before the main loop begins. A macro is provided to simplify the construction of
maps with multiple images.
let image_map = image_map! { (RUST_LOGO, try!(image::open("rust-logo.png"))), (CAT_PIC, try!(image::open("floof.jpeg"))), };
Fields
trigger_redraw: Cell<bool>
Whether or not the image::Map
will trigger a redraw the next time Ui::draw
is called.
This is automatically set to true
when any method that takes &mut self
is called.
Methods
impl<Img> Map<Img>
[src]
fn new() -> Map<Img>
[src]
Construct a new, empty image::Map
.
fn get_mut(&mut self, id: Id) -> Option<&mut Img>
[src]
Uniquely borrow the Img
associated with the given widget.
Note: Calling this will trigger a redraw the next time Ui::draw_if_changed
is called.
fn insert(&mut self, img: Img) -> Id
[src]
Inserts the given image into the map, returning its associated image::Id
. The user must
store the returned image::Id
in order to use, modify or remove the inserted image.
Note: Calling this will trigger a redraw the next time Ui::draw_if_changed
is called.
fn replace(&mut self, id: Id, img: Img) -> Option<Img>
[src]
Replaces the given image in the map if it exists. Returns the image or None.
Note: Calling this will trigger a redraw the next time Ui::draw_if_changed
is called.
fn remove(&mut self, id: Id) -> Option<Img>
[src]
Removes the given image from the map if it exists. Returns the image or None.
Any future use of the given image::Id
will be invalid.
Note: Calling this will trigger a redraw the next time Ui::draw_if_changed
is called.
fn extend<I>(&mut self, images: I) -> NewIds where
I: IntoIterator<Item = Img>,
[src]
I: IntoIterator<Item = Img>,
Insert each of the images yielded by the given iterator and produce an iterator yielding
their generated Ids
in the same order.
Note: Calling this will trigger a redraw the next time Ui::draw_if_changed
is called.
Methods from Deref<Target = HashMap<Id, Img, BuildHasherDefault<FnvHasher>>>
fn hasher(&self) -> &S
1.9.0[src]
Returns a reference to the map's BuildHasher
.
fn capacity(&self) -> usize
1.0.0[src]
Returns the number of elements the map can hold without reallocating.
This number is a lower bound; the HashMap<K, V>
might be able to hold
more, but is guaranteed to be able to hold at least this many.
Examples
use std::collections::HashMap; let map: HashMap<isize, isize> = HashMap::with_capacity(100); assert!(map.capacity() >= 100);
fn keys(&self) -> Keys<K, V>
1.0.0[src]
An iterator visiting all keys in arbitrary order.
The iterator element type is &'a K
.
Examples
use std::collections::HashMap; let mut map = HashMap::new(); map.insert("a", 1); map.insert("b", 2); map.insert("c", 3); for key in map.keys() { println!("{}", key); }
fn values(&self) -> Values<K, V>
1.0.0[src]
An iterator visiting all values in arbitrary order.
The iterator element type is &'a V
.
Examples
use std::collections::HashMap; let mut map = HashMap::new(); map.insert("a", 1); map.insert("b", 2); map.insert("c", 3); for val in map.values() { println!("{}", val); }
fn iter(&self) -> Iter<K, V>
1.0.0[src]
An iterator visiting all key-value pairs in arbitrary order.
The iterator element type is (&'a K, &'a V)
.
Examples
use std::collections::HashMap; let mut map = HashMap::new(); map.insert("a", 1); map.insert("b", 2); map.insert("c", 3); for (key, val) in map.iter() { println!("key: {} val: {}", key, val); }
fn len(&self) -> usize
1.0.0[src]
Returns the number of elements in the map.
Examples
use std::collections::HashMap; let mut a = HashMap::new(); assert_eq!(a.len(), 0); a.insert(1, "a"); assert_eq!(a.len(), 1);
fn is_empty(&self) -> bool
1.0.0[src]
Returns true if the map contains no elements.
Examples
use std::collections::HashMap; let mut a = HashMap::new(); assert!(a.is_empty()); a.insert(1, "a"); assert!(!a.is_empty());
fn get<Q>(&self, k: &Q) -> Option<&V> where
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,
1.0.0[src]
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,
Returns a reference to the value corresponding to the key.
The key may be any borrowed form of the map's key type, but
Hash
and Eq
on the borrowed form must match those for
the key type.
Examples
use std::collections::HashMap; let mut map = HashMap::new(); map.insert(1, "a"); assert_eq!(map.get(&1), Some(&"a")); assert_eq!(map.get(&2), None);
fn contains_key<Q>(&self, k: &Q) -> bool where
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,
1.0.0[src]
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,
Returns true if the map contains a value for the specified key.
The key may be any borrowed form of the map's key type, but
Hash
and Eq
on the borrowed form must match those for
the key type.
Examples
use std::collections::HashMap; let mut map = HashMap::new(); map.insert(1, "a"); assert_eq!(map.contains_key(&1), true); assert_eq!(map.contains_key(&2), false);