dcontext 0.9.0

Distributed context propagation for Rust — scoped, type-safe, serializable
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

use std::marker::PhantomData;

use crate::error::ContextError;
use crate::registry::RegistryBuilder;

/// A typed handle to a registered context entry.
///
/// Provides a type-safe, string-free API for get/set operations.
///
/// ```rust,ignore
/// static REQUEST_ID: ContextKey<RequestId> = ContextKey::new("request_id");
///
/// let mut builder = RegistryBuilder::new();
/// REQUEST_ID.register_on(&mut builder);
/// dcontext::initialize(builder);
///
/// REQUEST_ID.set(RequestId("req-123".into()));
/// let rid = REQUEST_ID.get();
/// ```
pub struct ContextKey<T: 'static> {
    key: &'static str,
    _marker: PhantomData<fn() -> T>,
}

impl<T> ContextKey<T>
where
    T: Clone + Default + Send + Sync + serde::Serialize + serde::de::DeserializeOwned + 'static,
{
    /// Create a new typed key handle. The key string is used for
    /// serialization and diagnostics only.
    pub const fn new(key: &'static str) -> Self {
        Self {
            key,
            _marker: PhantomData,
        }
    }

    /// Register this key on a builder. Panics on conflict.
    pub fn register_on(&self, builder: &mut RegistryBuilder) {
        builder.register::<T>(self.key);
    }

    /// Try to register this key on a builder.
    pub fn try_register_on(&self, builder: &mut RegistryBuilder) -> Result<(), ContextError> {
        builder.try_register::<T>(self.key)
    }

    /// Get the value. Returns `None` if not set.
    pub fn get(&self) -> Option<T> {
        crate::get_context_variable::<T>(self.key)
    }

    /// Set the value in the current scope.
    pub fn set(&self, value: T) {
        crate::set_context_variable::<T>(self.key, value);
    }

    /// Get the string key name.
    pub fn key(&self) -> &'static str {
        self.key
    }
}