Struct HmrState 

pub struct HmrState { /* private fields */ }

A serializable bag of preserved state entries.

Each entry is a (key, value) string pair. The caller is responsible for serializing non-string values (numbers, booleans, etc.) to strings before insertion.

Wire format

{"entries": {"k1": "v1", "k2": "v2"}}

Implementations

impl HmrState

Inherent implementation of HmrState.

pub fn new() -> Self

Creates a new empty HmrState.

pub fn from_entries<I>(entries: I) -> Self

where I: IntoIterator<Item = (String, String)>,

Creates an HmrState from an iterator of (key, value) pairs. Later pairs overwrite earlier ones for the same key.

Arguments

• I: IntoIterator<Item = (String, String)> - A generic type parameter.

pub fn set<K, V>(&mut self, key: K, value: V)

where K: Into<String>, V: Into<String>,

Sets a key-value pair. Overwrites any existing value for the key.

Arguments

• K: Into<String> - A generic type parameter.
• V: Into<String> - A generic type parameter.

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

Returns the value for the given key, or None.

Arguments

• &str - Shared reference to a str.

Returns

• Option<str> - The current value (or a snapshot thereof).

pub fn remove(&mut self, key: &str) -> Option<String>

Removes the entry for the given key, returning the previous value if any.

Arguments

• &str - Shared reference to a str.

Returns

• Option<String> - Some(...) on success, None otherwise.

pub fn clear(&mut self)

Removes every entry.

pub fn len(&self) -> usize

Returns the number of entries.

Returns

• usize - The number of items in the collection.

pub fn is_empty(&self) -> bool

Returns true if the state is empty.

Returns

• bool - true when the collection is empty.

pub fn contains(&self, key: &str) -> bool

Returns true if the state contains the given key.

Arguments

• &str - Shared reference to a str.

Returns

• bool - A boolean.

pub fn iter(&self) -> impl Iterator<Item = (&str, &str)>

Returns an iterator over the entries.

Returns

• impl Iterator<Item - A impl Iterator<Item value.

Trait Implementations

impl Clone for HmrState

fn clone(&self) -> HmrState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HmrState

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

Formats the value using the given formatter.

impl Default for HmrState

fn default() -> HmrState

Returns the “default value” for a type.

impl Eq for HmrState

impl PartialEq for HmrState

fn eq(&self, other: &HmrState) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for HmrState