commonware-runtime 2026.5.0

Execute asynchronous tasks with a configurable scheduler.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

use commonware_utils::sync::Mutex;
use std::sync::Arc;

// Wrap arbitrary `Send` guards so `Registration` can store them behind
// `Arc<dyn Send + Sync>` while still dropping the guard on last handle release.
struct GuardHolder<G>(Mutex<G>);

/// A shared lifecycle token for a [`Registered`](super::Registered) metric handle.
///
/// When the last clone of the associated [`Registered`](super::Registered)
/// handle is dropped, this registration is dropped as well. Runtime-managed
/// metrics use that drop to unregister themselves from the runtime registry,
/// while external callers may attach custom cleanup with [`Registration::from`].
#[derive(Clone)]
pub struct Registration {
    _guard: Arc<dyn Send + Sync>,
}

impl Registration {
    /// Create a registration from a guard that should be dropped when the last
    /// associated [`Registered`](super::Registered) handle is dropped.
    pub fn from<G>(guard: G) -> Self
    where
        G: Send + 'static,
    {
        Self {
            _guard: Arc::new(GuardHolder(Mutex::new(guard))),
        }
    }
}