ScopeLocal

Struct ScopeLocal 

Source
pub struct ScopeLocal<T> { /* private fields */ }
Expand description

Wrapper for scope-local values that are shared within a single scope.

ScopeLocal<T> provides ergonomic access to per-run context values like trace IDs, execution budgets, cancellation tokens, or any other data that should be shared across all services within a single agent run.

Unlike manually threading context through every service, ScopeLocal<T> makes context available anywhere within the scope with a simple resolver.get_required::<ScopeLocal<T>>() call.

§Thread Safety

The wrapped value is stored in an Arc<T>, making it cheaply clonable and safe to access from multiple threads within the same scope.

§Examples

use ferrous_di::{ServiceCollection, ScopeLocal, Resolver};
use std::sync::Arc;

#[derive(Default)]
struct RunContext {
    trace_id: String,
    max_steps: u32,
    budget_remaining: std::sync::atomic::AtomicU32,
}

let mut services = ServiceCollection::new();
 
// Register scope-local context
services.add_scope_local::<RunContext, _>(|_resolver| {
    Arc::new(RunContext {
        trace_id: "trace-12345".to_string(),
        max_steps: 50,
        budget_remaining: std::sync::atomic::AtomicU32::new(1000),
    })
});

// Any service can access the context
services.add_scoped_factory::<String, _>(|resolver| {
    let ctx = resolver.get_required::<ScopeLocal<RunContext>>();
    format!("Processing with trace: {}", ctx.trace_id)
});

let provider = services.build();
let scope1 = provider.create_scope();
let scope2 = provider.create_scope();

// Each scope gets its own context instance
let result1 = scope1.get_required::<String>();
let result2 = scope2.get_required::<String>();
// Different trace IDs in each scope

Implementations§

Source§

impl<T> ScopeLocal<T>

Source

pub fn new(value: T) -> Self

Creates a new scope-local wrapper around the given value.

Source

pub fn from_arc(value: Arc<T>) -> Self

Creates a new scope-local wrapper from an existing Arc.

Source

pub fn get(&self) -> &T

Gets a reference to the wrapped value.

Source

pub fn arc(&self) -> Arc<T>

Gets a clone of the underlying Arc.

This is cheap since Arc cloning only increments a reference count.

Trait Implementations§

Source§

impl<T> Clone for ScopeLocal<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for ScopeLocal<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Deref for ScopeLocal<T>

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.

Auto Trait Implementations§

§

impl<T> Freeze for ScopeLocal<T>

§

impl<T> RefUnwindSafe for ScopeLocal<T>
where T: RefUnwindSafe,

§

impl<T> Send for ScopeLocal<T>
where T: Sync + Send,

§

impl<T> Sync for ScopeLocal<T>
where T: Sync + Send,

§

impl<T> Unpin for ScopeLocal<T>

§

impl<T> UnwindSafe for ScopeLocal<T>
where T: RefUnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.