Skip to main content

Context

Struct Context 

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

Runtime context available to a code-defined capability tool.

This is a narrow projection: identity, locale, progress, and cancellation. Backend stores, credentials, tenant objects, registries, and host extensions intentionally remain host implementation details. Hosts build one per call via Context::new and the with_* seams; tests can do the same without any runtime.

Implementations§

Source§

impl Context

Source

pub fn new( tool_name: impl Into<String>, session_id: impl Into<String>, workspace_id: impl Into<String>, ) -> Self

Create a context with no-op progress and a never-cancelled signal.

Source

pub fn with_locale(self, locale: Option<String>) -> Self

Set the resolved BCP 47 locale.

Source

pub fn with_progress_sink(self, sink: Arc<dyn ProgressSink>) -> Self

Attach the host’s progress delivery seam.

Source

pub fn with_cancellation_signal( self, signal: Arc<dyn CancellationSignal>, ) -> Self

Attach the host’s call-scoped cancellation signal.

Source

pub fn tool_name(&self) -> &str

The tool name this context was created for.

Source

pub fn session_id(&self) -> &str

Opaque session identifier for correlation and application-side scoping.

Source

pub fn workspace_id(&self) -> &str

Opaque identifier of the workspace attached to this session.

Source

pub fn locale(&self) -> Option<&str>

Resolved BCP 47 locale, when the host supplied one.

Source

pub fn cancellation(&self) -> &CallCancellation

Call-scoped cancellation signal for work that may outlive execute.

Source

pub async fn progress(&self, message: impl AsRef<str>)

Emit a best-effort, correlated tool.progress event.

Delivery failure never fails the tool.

Trait Implementations§

Source§

impl Clone for Context

Source§

fn clone(&self) -> Context

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 Context

Source§

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

Formats the value using the given formatter. 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<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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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