Struct budvm::HashMap

pub struct HashMap<State = RandomState>(_)
where
         State: BuildHasher;

A wrapper for std::collections::HashMap<Value,Value> that prevents using a Value that does not support hashing by returning an error.

This type uses a Mutex for interior mutability.

Implementations

impl HashMap<RandomState>

pub fn new() -> Self

Returns a new, empty hash map.

Equivalent to std::collections::HashMap::new().

impl<State> HashMap<State>where State: BuildHasher,

pub fn len(&self) -> usize

Returns the number of items contained.

pub fn is_empty(&self) -> bool

Returns true if this map contains no items.

pub fn insert(&self, k: Value, v: Value) -> Result<Option<Value>, FaultKind>

Inserts a key-value pair into the map.

Equivalent to std::collections::HashMap::insert(), except this function checks that key.implements_hash() returns true. If it does not, FaultKind::ValueCannotBeHashed will be returned.

pub fn get(&self, key: &Value) -> Option<Value>

Returns the value associated with key, if present.

pub fn remove(&self, key: &Value) -> Option<Value>

Removes the value associated with key, if present.

pub fn into_inner(self) -> BudMap<Value, Value, State>

Extracts the contained collection type.

Trait Implementations

impl<State> Clone for HashMap<State>where State: Clone + BuildHasher,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<State> Debug for HashMap<State>where State: BuildHasher + Debug,

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

Formats the value using the given formatter.

impl Default for HashMap<RandomState>

fn default() -> Self

Returns the “default value” for a type.

impl<State> DynamicValue for HashMap<State>where State: BuildHasher + Debug + Clone + Send + Sync + 'static,

fn is_truthy(&self) -> bool

Returns true if the value contained is truthy. See Value::is_truthy() for examples of what this means for primitive types.

fn kind(&self) -> Symbol

Returns a unique string identifying this type. This returned string will be wrapped in ValueKind::Dynamic when Value::kind() is invoked on a dynamic value.

fn partial_eq(&self, other: &Value) -> Option<bool>

Returns true if self and other are considered equal. Returns false if self and other are able to be compared but are not equal. Returns None if the values are unable to be compared.

fn call( &self, name: &Symbol, args: &mut PoppedValues<'_> ) -> Result<Value, FaultKind>

Calls a function by name with args.

fn to_source(&self) -> Option<String>

Returns this value as represented in source, if possible.

fn as_i64(&self) -> Option<i64>

Returns this value as an i64, if possible.

fn convert(&self, kind: &Symbol) -> Option<Value>

Converts this value to the given kind, if possible.

fn partial_cmp(&self, other: &Value) -> Option<Ordering>

Returns the relative ordering of self and other, if a comparison is able to be made. If the types cannot be compared, this function should return None.

fn checked_add( &self, other: &Value, is_reverse: bool ) -> Result<Option<Value>, FaultKind>

Attempts to compute the result adding self and other.

fn checked_sub( &self, other: &Value, is_reverse: bool ) -> Result<Option<Value>, FaultKind>

Attempts to compute the result subtracting self and other.

fn checked_mul( &self, other: &Value, is_reverse: bool ) -> Result<Option<Value>, FaultKind>

Attempts to compute the result multiplying self and other.

fn checked_div( &self, other: &Value, is_reverse: bool ) -> Result<Option<Value>, FaultKind>

Attempts to compute the result dividing self and other.

fn hash<H>(&self, state: &mut H) -> boolwhere H: Hasher,

Hashes the contents of this value. Returns true if this operation is supported.

impl<'a> TryFrom<PoppedValues<'a>> for HashMap<RandomState>

type Error = FaultKind

The type returned in the event of a conversion error.

fn try_from(values: PoppedValues<'a>) -> Result<Self, Self::Error>

Performs the conversion.