Struct bank_vault::Vault

pub struct Vault<T> { /* fields omitted */ }

Implementations

impl<T> Vault<T>

pub fn new() -> Vault<T>

Creates a new, empty Vault instance.

Example

let vault = Vault::<i32>::new();

pub fn add(&self, to_add: T) -> VaultKey

Adds an object to the vault and returns a key.

Example

let vault = Vault::<i32>::new();
 
let key = vault.add(1);

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

Removes and returns the stored object with a matching key, if it exists, otherwise returns None.

Example

let vault = Vault::<i32>::new();
let key = vault.add(1);
 
let item = vault.remove(&key);
assert_eq!(Some(1), item);

pub fn has_item(&self, key: &VaultKey) -> bool

Returns true if there exists an item in the vault with the provided key, otherwise returns false.

Example

let vault = Vault::<i32>::new();
let key = vault.add(1);
 
let has_item = vault.has_item(&key);
assert_eq!(true, has_item);

pub fn add_with_key(&self, to_add: T, key: &VaultKey) -> bool

Adds an item to the vault with the specified key. If the key already is in use, the item is not added and this returns false. If the key is not already in use, the item is added and returns true.

Example

let vault = Vault::<i32>::new();
let key = VaultKey::new();
 
let is_true = vault.add_with_key(1, &key);
assert_eq!(true, is_true);
let is_false = vault.add_with_key(2, &key);
assert_eq!(false, is_false);

pub fn update_item<F>(&self, key: &VaultKey, operation: F) -> bool where
    F: FnMut(T) -> T, 

Updates an item in the vault with the specified key by applying the operation to it. Returns false if an item with the key is not found, otherwise returns true.

Example

let vault = Vault::<i32>::new();
let key = vault.add(1);
 
let double_me = |i:i32| i * 2;
 
let updated = vault.update_item(&key, double_me);
assert_eq!(true, updated);

pub fn clear(&self)

Clears the contents of the vault.

Example

let vault = Vault::<i32>::new();
let key = vault.add(1);
 
vault.clear();
 
let has_item = vault.has_item(&key);
assert_eq!(false, has_item);