Struct Registry

pub struct Registry<T> { /* private fields */ }

Global Object Registry Visitor

This struct is used to register and access global objects of a specific type.

Example

use gom::Registry;

Registry::register("key", 123);
let value = Registry::<i32>::apply("key", |v| *v + 1);
assert_eq!(value, Some(124));

Implementations

impl<T: Send + 'static> Registry<T>

pub fn register(key: &str, value: T)

Register a new value with the given key

If the key already exists in the same type, the value will be overwritten.

Example

use gom::Registry;

Registry::register("key", 123);

Examples found in repository

examples/example.rs (line 7)

fn main() {
    Registry::register(ID, vec![1, 2, 3]);

    Registry::<Vec<i32>>::with(ID, |v| {
        v.push(4);
    });

    let v = Registry::<Vec<i32>>::remove(ID);
    println!("{:?}", v);
}

pub fn apply<R, F: FnOnce(&mut T) -> R>(key: &str, f: F) -> Option<R>

Apply a function to the value with the given key

If this function is nested, it will cause thread deadlock.

If the key does not exist, the function will not be called and None will be returned.

Returns

Some(R) if the key exists and the function was applied successfully, None otherwise.

Example

use gom::Registry;

Registry::register("key", 123);
let value = Registry::<i32>::apply("key", |v| *v + 1);
assert_eq!(value, Some(124));

pub fn remove(key: &str) -> Option<T>

Get the value with the given key and reomve it from the registry

If the key does not exist, None will be returned.

Returns

Some(T) if the key exists, None otherwise.

Example

use gom::Registry;

Registry::register("key", 123);
let value = Registry::<i32>::remove("key");
assert_eq!(value, Some(123));
let value = Registry::<i32>::remove("key");
assert_eq!(value, None);

Examples found in repository

examples/example.rs (line 13)

fn main() {
    Registry::register(ID, vec![1, 2, 3]);

    Registry::<Vec<i32>>::with(ID, |v| {
        v.push(4);
    });

    let v = Registry::<Vec<i32>>::remove(ID);
    println!("{:?}", v);
}

pub fn with<R, F: FnOnce(&mut T) -> R>(key: &str, f: F) -> Option<R>

Apply a function to the value with the given key

This function will not cause thread deadlocks.

If the key does not exist, the function will not be called and None will be returned.

In the context of ‘with’, the value cannot be retrieved again.

Returns

Some(R) if the key exists and the function was applied successfully, None otherwise.

Example

use gom::Registry;

Registry::register("key", 123);
let value = Registry::<i32>::with("key", |v| *v + 1);
assert_eq!(value, Some(124));

Examples found in repository

examples/example.rs (lines 9-11)

fn main() {
    Registry::register(ID, vec![1, 2, 3]);

    Registry::<Vec<i32>>::with(ID, |v| {
        v.push(4);
    });

    let v = Registry::<Vec<i32>>::remove(ID);
    println!("{:?}", v);
}