Skip to main content

TurnContext

Struct TurnContext 

Source
pub struct TurnContext {
    pub id: TurnId,
    pub cancel_token: CancellationToken,
    pub timeouts: TimeoutConfig,
    pub tool_allowlist: Option<Vec<String>>,
}
Expand description

Per-turn execution context shared across phases (loop, compose, persist).

TurnContext is Send + 'static and cheaply cloneable so it can be passed by value into subsystems that may outlive a &mut Turn borrow (background tasks, sub-services extracted to other crates in Phase 2 of the agent decomposition).

It carries only data that is (a) immutable for the duration of the turn or (b) intrinsically Send + Clone (the cancellation token).

§Examples

use zeph_context::turn_context::{TurnContext, TurnId};
use zeph_config::security::TimeoutConfig;
use tokio_util::sync::CancellationToken;

let ctx = TurnContext::new(TurnId(0), CancellationToken::new(), TimeoutConfig::default());
assert_eq!(ctx.id, TurnId(0));

Fields§

§id: TurnId

Monotonically increasing identifier for this turn within the conversation.

§cancel_token: CancellationToken

Per-turn cancellation token. A fresh token is created in Agent::begin_turn. Cancelled when the user aborts the turn or the agent shuts down.

§timeouts: TimeoutConfig

Effective timeout configuration snapshotted at the start of the turn.

Snapshotting (rather than reading from a shared config) ensures the turn’s timeout policy is stable even if the live config is reloaded mid-turn.

§tool_allowlist: Option<Vec<String>>

Optional channel-scoped tool allowlist for this turn.

None means no channel-level restriction applies (other layers may still gate tool access). When Some, only tools whose names appear in the list may be dispatched; any call to a tool not in the list is rejected before execution.

Populated from the active channel’s allowed_tools config by the agent runtime at turn start via TurnContext::with_tool_allowlist.

Implementations§

Source§

impl TurnContext

Source

pub fn new( id: TurnId, cancel_token: CancellationToken, timeouts: TimeoutConfig, ) -> Self

Create a new TurnContext with no channel-level tool restriction.

Use with_tool_allowlist to set a channel-scoped allowlist.

§Examples
use zeph_context::turn_context::{TurnContext, TurnId};
use zeph_config::security::TimeoutConfig;
use tokio_util::sync::CancellationToken;

let ctx = TurnContext::new(TurnId(1), CancellationToken::new(), TimeoutConfig::default());
assert_eq!(ctx.id, TurnId(1));
assert!(ctx.tool_allowlist.is_none());
Source

pub fn with_tool_allowlist(self, allowlist: Option<Vec<String>>) -> Self

Set the channel-scoped tool allowlist for this turn.

None clears any existing restriction. Some(vec![]) denies all tools.

§Examples
use zeph_context::turn_context::{TurnContext, TurnId};
use zeph_config::security::TimeoutConfig;
use tokio_util::sync::CancellationToken;

let ctx = TurnContext::new(TurnId(0), CancellationToken::new(), TimeoutConfig::default())
    .with_tool_allowlist(Some(vec!["shell".to_owned(), "grep".to_owned()]));
assert!(ctx.is_tool_allowed("shell"));
assert!(!ctx.is_tool_allowed("web_scrape"));
Source

pub fn is_tool_allowed(&self, tool_name: &str) -> bool

Returns true if tool_name is permitted by the channel-level allowlist.

When no allowlist is set (None), all tools are permitted. When the allowlist is Some, only tools explicitly listed are permitted.

Comparison is case-sensitive: "Shell" and "shell" are treated as different names. Callers must normalize tool names to lowercase before populating the allowlist if case-insensitive matching is required.

§Examples
use zeph_context::turn_context::{TurnContext, TurnId};
use zeph_config::security::TimeoutConfig;
use tokio_util::sync::CancellationToken;

let unrestricted = TurnContext::new(TurnId(0), CancellationToken::new(), TimeoutConfig::default());
assert!(unrestricted.is_tool_allowed("anything"));

let restricted = unrestricted.with_tool_allowlist(Some(vec!["shell".to_owned()]));
assert!(restricted.is_tool_allowed("shell"));
assert!(!restricted.is_tool_allowed("web_scrape"));

Trait Implementations§

Source§

impl Clone for TurnContext

Source§

fn clone(&self) -> TurnContext

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 TurnContext

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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> 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.
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