Skip to main content

ReadOnlyContext

Struct ReadOnlyContext 

Source
pub struct ReadOnlyContext<'a> { /* private fields */ }
Expand description

Immutable snapshot of step context passed to AgentBehavior phase hooks.

The loop builds a ReadOnlyContext from the current StepContext before each phase hook and passes it by shared reference. Plugins read data from this snapshot and return a typed ActionSet describing effects to apply.

Implementations§

Source§

impl<'a> ReadOnlyContext<'a>

Source

pub fn new( phase: Phase, thread_id: &'a str, messages: &'a [Arc<Message>], run_policy: &'a RunPolicy, doc: &'a DocCell, ) -> Self

Source

pub fn with_llm_response(self, response: &'a LLMResponse) -> Self

Source

pub fn with_tool_info( self, name: &'a str, call_id: &'a str, args: Option<&'a Value>, ) -> Self

Source

pub fn with_tool_result(self, result: &'a ToolResult) -> Self

Source

pub fn with_resume_input(self, resume: ToolCallResume) -> Self

Source

pub fn with_scope_ctx(self, scope_ctx: ScopeContext) -> Self

Source

pub fn phase(&self) -> Phase

Source

pub fn thread_id(&self) -> &str

Source

pub fn messages(&self) -> &[Arc<Message>]

Source

pub fn initial_message_count(&self) -> usize

Number of messages that existed before the current run started.

Source

pub fn run_policy(&self) -> &RunPolicy

Source

pub fn run_identity(&self) -> &RunIdentity

Source

pub fn doc(&self) -> &DocCell

Source

pub fn response(&self) -> Option<&StreamResult>

Source

pub fn inference_error(&self) -> Option<&InferenceError>

Source

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

Source

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

Source

pub fn tool_args(&self) -> Option<&Value>

Source

pub fn tool_result(&self) -> Option<&ToolResult>

Source

pub fn resume_input(&self) -> Option<&ToolCallResume>

Source

pub fn snapshot(&self) -> Value

Source

pub fn snapshot_of<T: State>(&self) -> TireaResult<T>

Source

pub fn scoped_state_of<T: StateSpec>(&self, scope: StateScope) -> TireaResult<T>

Scope-aware state read for StateSpec types.

Source

pub fn scope_ctx(&self) -> &ScopeContext

Source

pub fn with_run_identity(self, run_identity: &RunIdentity) -> Self

Auto Trait Implementations§

§

impl<'a> Freeze for ReadOnlyContext<'a>

§

impl<'a> RefUnwindSafe for ReadOnlyContext<'a>

§

impl<'a> Send for ReadOnlyContext<'a>

§

impl<'a> Sync for ReadOnlyContext<'a>

§

impl<'a> Unpin for ReadOnlyContext<'a>

§

impl<'a> UnsafeUnpin for ReadOnlyContext<'a>

§

impl<'a> UnwindSafe for ReadOnlyContext<'a>

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