Struct StringHashMap

Source
pub struct StringHashMap<Value> { /* private fields */ }
Expand description

StringHashMap is a trusted wrapper around std::collections::HashMap<String, Value> with View implemented for the type vstd::map::Map<Seq<char>, Value>.

This type was created for ease of use with String as it uses &str instead of &String for methods that require shared references. Also, it assumes that obeys_key_model::<String>() holds.

See the Rust documentation for HashMap for details about its implementation.

If you are using std::collections::HashMap directly, see ExHashMap for information on the Verus specifications for this type.

Implementations§

Source§

impl<Value> StringHashMap<Value>

Source

pub exec fn new() -> result : Self

ensures
result@ == Map::<Seq<char>, Value>::empty(),

Creates an empty StringHashMap with a capacity of 0.

See Rust’s HashMap::new() for implementation details.

Source

pub exec fn with_capacity(capacity: usize) -> result : Self

ensures
result@ == Map::<Seq<char>, Value>::empty(),

Creates an empty StringHashMap with at least capacity for the specified number of elements.

See Rust’s HashMap::with_capacity() for implementation details.

Source

pub exec fn reserve(&mut self, additional: usize)

ensures
self@ == old(self)@,

Reserves capacity for at least additional number of elements in the map.

See Rust’s HashMap::reserve() for implementation details.

Source

pub exec fn is_empty(&self) -> result : bool

ensures
result == self@.is_empty(),

Returns true if the map is empty.

Source

pub uninterp fn spec_len(&self) -> usize

Returns the number of elements in the map.

Source

pub exec fn len(&self) -> result : usize

ensures
result == self@.len(),

Returns the number of elements in the map.

Source

pub exec fn insert(&mut self, k: String, v: Value)

ensures
self@ == old(self)@.insert(k@, v),

Inserts the given key and value in the map.

See Rust’s HashMap::insert() for implementation details.

Source

pub exec fn remove(&mut self, k: &str)

ensures
self@ == old(self)@.remove(k@),

Removes the given key from the map. If the key is not present in the map, the map is unmodified.

See Rust’s HashMap::remove() for implementation details.

Source

pub exec fn contains_key(&self, k: &str) -> result : bool

ensures
result == self@.contains_key(k@),

Returns true if the map contains the given key.

See Rust’s HashMap::contains_key() for implementation details.

Source

pub exec fn get<'a>(&'a self, k: &str) -> result : Option<&'a Value>

ensures
match result {
    Some(v) => self@.contains_key(k@) && *v == self@[k@],
    None => !self@.contains_key(k@),
},

Returns a reference to the value corresponding to the given key in the map. If the key is not present in the map, returns None.

See Rust’s HashMap::get() for implementation details.

Source

pub exec fn clear(&mut self)

ensures
self@ == Map::<Seq<char>, Value>::empty(),

Clears all key-value pairs in the map. Retains the allocated memory for reuse.

See Rust’s HashMap::clear() for implementation details.

Source

pub exec fn union_prefer_right(&mut self, other: Self)

ensures
self@ == old(self)@.union_prefer_right(other@),

Returns the union of the two maps. If a key is present in both maps, then the value in the right map (other) is retained.

Trait Implementations§

Source§

impl<Value> View for StringHashMap<Value>

Source§

uninterp fn view(&self) -> Self::V

Source§

type V = Map<Seq<char>, Value>

Auto Trait Implementations§

§

impl<Value> Freeze for StringHashMap<Value>

§

impl<Value> RefUnwindSafe for StringHashMap<Value>
where Value: RefUnwindSafe,

§

impl<Value> Send for StringHashMap<Value>
where Value: Send,

§

impl<Value> Sync for StringHashMap<Value>
where Value: Sync,

§

impl<Value> Unpin for StringHashMap<Value>
where Value: Unpin,

§

impl<Value> UnwindSafe for StringHashMap<Value>
where Value: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.