Skip to main content

ToolContext

Struct ToolContext 

Source
pub struct ToolContext {
    pub meta: Meta,
    /* private fields */
}
Expand description

Tool execution context

Thread-safe context using Arc<DashMap> for extensions. Can be freely cloned and passed across await points.

§Thread Safety

All operations are thread-safe:

  • insert, get, remove use DashMap’s concurrent HashMap
  • Extensions wrapped in Arc<T> for cheap cloning

§Examples

use descry_tool_core::ToolContext;
use std::sync::Arc;

let ctx = Arc::new(ToolContext::new());

// Insert extension
#[derive(Debug)]
struct MyService;
ctx.insert(MyService);

Fields§

§meta: Meta

Request metadata

Implementations§

Source§

impl ToolContext

Source

pub fn new() -> Self

Create a new context with empty args

Source

pub fn with_args(args: JsonObject) -> Self

Create context with args

Source

pub fn empty() -> Self

Create empty context

Source

pub fn with_meta(self, meta: Meta) -> Self

Set metadata

Source

pub fn take_args(&mut self) -> Option<JsonObject>

Take and consume the raw arguments

This can only be called once. Subsequent calls will return None.

Source

pub fn peek_args(&self) -> Option<&JsonObject>

Peek at the raw arguments without consuming

Source

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

Insert an extension into the context

Returns the previous value if it existed.

Source

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

Get a reference to an extension

Source

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

Remove an extension from the context

Source

pub fn contains<T>(&self) -> bool
where T: Send + Sync + 'static,

Check if an extension exists

Source

pub fn clear(&self)

Clear all extensions

Source

pub fn len(&self) -> usize

Get extension count

Source

pub fn is_empty(&self) -> bool

Check if extensions is empty

Trait Implementations§

Source§

impl Clone for ToolContext

Source§

fn clone(&self) -> ToolContext

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 Debug for ToolContext

Source§

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

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

impl Default for ToolContext

Source§

fn default() -> Self

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