Struct RunContext 

#[non_exhaustive]
pub struct RunContext<'a> {
    pub run_id: &'a str,
    pub label: Option<&'a str>,
    pub prompts: &'a [Message],
    pub depth: usize,
    pub delegated_by: Option<&'a str>,
    pub parent_run_id: Option<&'a str>,
    pub inherited: bool,
    pub cancel: &'a CancellationToken,
    /* private fields */
}

The run a hook belongs to.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

run_id: &'a str

Unique per run, generated by the loop.

label: Option<&'a str>

The host’s label for the run, set with Agent::with_run_label (a session id, say). yoagent does not interpret it. Delegated runs keep their parent’s.

prompts: &'a [Message]

The run’s prompts (for a delegated run: its task). Empty for a continue_loop run.

depth: usize

0 for a top-level run, 1 for a sub-agent’s run, and so on.

delegated_by: Option<&'a str>

For a delegated run: the id of the tool call that started it (in the calling run).

parent_run_id: Option<&'a str>

For a delegated run whose caller has extensions: the caller’s run_id. With delegated_by, it names the delegation uniquely.

inherited: bool

In start_run: this extension came from the calling run’s tree (Agent::with_tree_extension), so the calling run has it too.

cancel: &'a CancellationToken

The run’s cancellation token.

Implementations

impl<'a> RunContext<'a>

pub fn new( run_id: &'a str, prompts: &'a [Message], cancel: &'a CancellationToken, ) -> Self

A context for a top-level run with no label, for testing extensions.

pub fn with_label(self, label: &'a str) -> Self

With the host’s label.

pub fn with_depth(self, depth: usize) -> Self

At this delegation depth.

pub fn with_delegated_by(self, parent_run_id: &'a str, call_id: &'a str) -> Self

Started by this tool call of the calling run parent_run_id.

pub fn is_delegation(&self) -> bool

Whether this run is a delegation (a sub-agent’s run).

Trait Implementations

impl<'a> Clone for RunContext<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for RunContext<'a>

impl<'a> Debug for RunContext<'a>

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

Formats the value using the given formatter.