Skip to main content

RunLocals

Struct RunLocals 

Source
pub struct RunLocals { /* private fields */ }
Expand description

What a turn tells its tools about who it works for — set on TurnOptions::locals, read back with ToolContext::run_local (ADR-0044). Re-exported under the rule stated on CancellationToken. Values a host attaches to one run, for the tools that run calls to read.

The per-run sibling of Runtime::app_context. An app context is the runtime’s, so every run on it reads the same value — right for a client handle, wrong for who this run works for. A host that serves many callers from one runtime and one toolset has exactly that second kind of fact: a caller’s workspace, a tenant, a trace id. Without a slot here it either opens a toolset per caller or keys a side table by agent id; with one, it attaches the value to the run and the tool reads it back through ToolContext::run_local.

Keyed by type, at most one value per type, as app_context is: a host wraps a bare String in a newtype of its own so two hosts’ strings cannot collide. Values are Arced and the map is copy-on-write, so cloning a RunOptions — which the runner does freely — costs one reference count.

Inherited by RunOptions::child: a delegated run works for the same caller as the run that delegated it, and a tool the child calls has to see the same answer.

Implementations§

Source§

impl RunLocals

Source

pub fn new() -> RunLocals

Source

pub fn with<T>(self, value: T) -> RunLocals
where T: Any + Send + Sync + 'static,

Attaches value, replacing any value of the same type.

Source

pub fn with_arc<T>(self, value: Arc<T>) -> RunLocals
where T: Any + Send + Sync + 'static,

Attaches a value the host already shares, replacing any value of the same type.

Source

pub fn get<T>(&self) -> Option<Arc<T>>
where T: Any + Send + Sync + 'static,

The value of type T, when one is attached.

Source

pub fn is_empty(&self) -> bool

Source

pub fn layered(self, over: &RunLocals) -> RunLocals

self with every value of over attached on top: where both hold a type, over’s wins.

Trait Implementations§

Source§

impl Clone for RunLocals

Source§

fn clone(&self) -> RunLocals

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RunLocals

Names the attached types, not their values: the values are the host’s and need not be Debug.

Source§

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

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

impl Default for RunLocals

Source§

fn default() -> RunLocals

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more