Struct Registry

pub struct Registry(/* private fields */);

The registry of multiple await-trees.

Can be cheaply cloned to share the same registry.

Implementations

impl Registry

pub fn new(config: Config) -> Self

Create a new registry with given config.

pub fn try_current() -> Option<Self>

Returns the current registry, if exists.

1. If the current task is registered with a registry, returns the registry.
2. If the global registry is initialized with init_global_registry, returns the global registry.
3. Otherwise, returns None.

pub fn current() -> Self

Returns the current registry, panics if not exists.

See Registry::try_current for more information.

pub fn register(&self, key: impl Key, root_span: impl Into<Span>) -> TreeRoot

Register with given key and root span. Returns a TreeRoot that can be used to instrument a future.

If the key already exists, a new TreeRoot is returned and the reference to the old TreeRoot is dropped.

pub fn register_derived_root(&self, key: impl Key + ToRootSpan) -> TreeRoot

Derive the root span from the given key and register with it.

This is a convenience method for self.register(key, key.to_root_span()). See Registry::register for more details.

pub fn register_anonymous(&self, root_span: impl Into<Span>) -> TreeRoot

Register an anonymous await-tree without specifying a key. Returns a TreeRoot that can be used to instrument a future.

Anonymous await-trees are not able to be retrieved through the Registry::get method. Use Registry::collect_anonymous or Registry::collect_all to collect them.

pub fn get(&self, key: impl Key) -> Option<Tree>

Get a clone of the await-tree with given key.

Returns None if the key does not exist or the tree root has been dropped.

pub fn clear(&self)

Remove all the registered await-trees.

pub fn collect<K: Key + Clone>(&self) -> Vec<(K, Tree)>

Collect the snapshots of all await-trees with the key of type K.

pub fn collect_anonymous(&self) -> Vec<Tree>

Collect the snapshots of all await-trees registered with Registry::register_anonymous.

pub fn collect_all(&self) -> Vec<(AnyKey, Tree)>

Collect the snapshots of all await-trees regardless of the key type.

Trait Implementations

impl Clone for Registry

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Registry

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

Formats the value using the given formatter.