Struct anymap::Map
[−]
[src]
pub struct Map<A: ?Sized + UncheckedAnyExt = Any> { /* fields omitted */ }
A collection containing zero or one values for any given type and allowing convenient, type-safe access to those values.
The type parameter A
allows you to use a different value type; normally you will want it to
be anymap::any::Any
, but there are other choices:
- If you want the entire map to be cloneable, use
CloneAny
instead ofAny
. - You can add on
+ Send
and/or+ Sync
(e.g.Map<Any + Send>
) to add those bounds.
let mut data = AnyMap::new(); assert_eq!(data.get(), None::<&i32>); data.insert(42i32); assert_eq!(data.get(), Some(&42i32)); data.remove::<i32>(); assert_eq!(data.get::<i32>(), None); #[derive(Clone, PartialEq, Debug)] struct Foo { str: String, } assert_eq!(data.get::<Foo>(), None); data.insert(Foo { str: format!("foo") }); assert_eq!(data.get(), Some(&Foo { str: format!("foo") })); data.get_mut::<Foo>().map(|foo| foo.str.push('t')); assert_eq!(&*data.get::<Foo>().unwrap().str, "foot");
Values containing non-static references are not permitted.
Methods
impl<A: ?Sized + UncheckedAnyExt> Map<A>
[src]
impl<A: ?Sized + UncheckedAnyExt> Map<A>
pub fn new() -> Map<A>
[src]
pub fn new() -> Map<A>
Create an empty collection.
pub fn with_capacity(capacity: usize) -> Map<A>
[src]
pub fn with_capacity(capacity: usize) -> Map<A>
Creates an empty collection with the given initial capacity.
pub fn capacity(&self) -> usize
[src]
pub fn capacity(&self) -> usize
Returns the number of elements the collection can hold without reallocating.
pub fn reserve(&mut self, additional: usize)
[src]
pub fn reserve(&mut self, additional: usize)
Reserves capacity for at least additional
more elements to be inserted
in the collection. The collection may reserve more space to avoid
frequent reallocations.
Panics
Panics if the new allocation size overflows usize
.
pub fn shrink_to_fit(&mut self)
[src]
pub fn shrink_to_fit(&mut self)
Shrinks the capacity of the collection as much as possible. It will drop down as much as possible while maintaining the internal rules and possibly leaving some space in accordance with the resize policy.
pub fn len(&self) -> usize
[src]
pub fn len(&self) -> usize
Returns the number of items in the collection.
pub fn is_empty(&self) -> bool
[src]
pub fn is_empty(&self) -> bool
Returns true if there are no items in the collection.
pub fn clear(&mut self)
[src]
pub fn clear(&mut self)
Removes all items from the collection. Keeps the allocated memory for reuse.
impl<A: ?Sized + UncheckedAnyExt> Map<A>
[src]
impl<A: ?Sized + UncheckedAnyExt> Map<A>
pub fn get<T: IntoBox<A>>(&self) -> Option<&T>
[src]
pub fn get<T: IntoBox<A>>(&self) -> Option<&T>
Returns a reference to the value stored in the collection for the type T
, if it exists.
pub fn get_mut<T: IntoBox<A>>(&mut self) -> Option<&mut T>
[src]
pub fn get_mut<T: IntoBox<A>>(&mut self) -> Option<&mut T>
Returns a mutable reference to the value stored in the collection for the type T
,
if it exists.
pub fn insert<T: IntoBox<A>>(&mut self, value: T) -> Option<T>
[src]
pub fn insert<T: IntoBox<A>>(&mut self, value: T) -> Option<T>
Sets the value stored in the collection for the type T
.
If the collection already had a value of type T
, that value is returned.
Otherwise, None
is returned.
pub fn remove<T: IntoBox<A>>(&mut self) -> Option<T>
[src]
pub fn remove<T: IntoBox<A>>(&mut self) -> Option<T>
Removes the T
value from the collection,
returning it if there was one or None
if there was not.
pub fn contains<T: IntoBox<A>>(&self) -> bool
[src]
pub fn contains<T: IntoBox<A>>(&self) -> bool
Returns true if the collection contains a value of type T
.
pub fn entry<T: IntoBox<A>>(&mut self) -> Entry<A, T>
[src]
pub fn entry<T: IntoBox<A>>(&mut self) -> Entry<A, T>
Gets the entry for the given type in the collection for in-place manipulation
Trait Implementations
impl<A: Debug + ?Sized + UncheckedAnyExt> Debug for Map<A>
[src]
impl<A: Debug + ?Sized + UncheckedAnyExt> Debug for Map<A>
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl<A: ?Sized + UncheckedAnyExt> Clone for Map<A> where
Box<A>: Clone,
[src]
impl<A: ?Sized + UncheckedAnyExt> Clone for Map<A> where
Box<A>: Clone,
fn clone(&self) -> Map<A>
[src]
fn clone(&self) -> Map<A>
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl<A: ?Sized + UncheckedAnyExt> AsRef<RawMap<A>> for Map<A>
[src]
impl<A: ?Sized + UncheckedAnyExt> AsRef<RawMap<A>> for Map<A>
impl<A: ?Sized + UncheckedAnyExt> AsMut<RawMap<A>> for Map<A>
[src]
impl<A: ?Sized + UncheckedAnyExt> AsMut<RawMap<A>> for Map<A>
impl<A: ?Sized + UncheckedAnyExt> Into<RawMap<A>> for Map<A>
[src]
impl<A: ?Sized + UncheckedAnyExt> Into<RawMap<A>> for Map<A>