Skip to main content

TaskContext

Struct TaskContext 

Source
pub struct TaskContext {
    pub forge: Option<Forge>,
    pub workflow_id: String,
    pub task_id: TaskId,
    pub task_timeout: Option<Duration>,
    pub tool_registry: Option<Arc<ToolRegistry>>,
    pub audit_log: Option<AuditLog>,
    /* private fields */
}
Expand description

Execution context provided to workflow tasks.

Provides access to the Forge SDK for graph operations, metadata about the current workflow execution, and cancellation token.

Fields§

§forge: Option<Forge>

Optional Forge instance for graph queries

§workflow_id: String

Workflow identifier for this execution

§task_id: TaskId

Task identifier for this execution

§task_timeout: Option<Duration>

Optional task timeout duration

§tool_registry: Option<Arc<ToolRegistry>>

Optional tool registry for tool invocation

§audit_log: Option<AuditLog>

Optional audit log for recording events (cloned from executor)

Implementations§

Source§

impl TaskContext

Source

pub fn new(workflow_id: impl Into<String>, task_id: TaskId) -> Self

Creates a new TaskContext.

Source

pub fn with_forge(self, forge: Forge) -> Self

Sets the Forge instance for graph operations.

Source

pub fn with_cancellation_token(self, token: CancellationToken) -> Self

Sets the cancellation token for cooperative cancellation.

§Arguments
  • token - The cancellation token to check during task execution
§Returns

The context with cancellation token set (for builder pattern)

§Example
use forge_agent::workflow::{CancellationTokenSource, TaskContext};

let source = CancellationTokenSource::new();
let context = TaskContext::new("workflow-1", task_id)
    .with_cancellation_token(source.token());
Source

pub fn cancellation_token(&self) -> Option<&CancellationToken>

Returns a reference to the cancellation token if set.

Tasks can use this to check for cancellation during execution.

§Example
async fn execute(&self, context: &TaskContext) -> Result<TaskResult, TaskError> {
    if let Some(token) = context.cancellation_token() {
        if token.is_cancelled() {
            return Ok(TaskResult::Skipped);
        }
    }
    // ... do work
}
Source

pub fn with_task_timeout(self, timeout: Duration) -> Self

Sets the task timeout for this context.

§Arguments
  • timeout - The timeout duration for the task
§Returns

The context with task timeout set (for builder pattern)

§Example
use std::time::Duration;

let context = TaskContext::new("workflow-1", task_id)
    .with_task_timeout(Duration::from_secs(30));
Source

pub fn with_tool_registry(self, registry: Arc<ToolRegistry>) -> Self

Sets the tool registry for tool invocation.

§Arguments
  • registry - The tool registry to use for tool invocation
§Returns

The context with tool registry set (for builder pattern)

§Example
use forge_agent::workflow::tools::ToolRegistry;
use std::sync::Arc;

let registry = Arc::new(ToolRegistry::new());
let context = TaskContext::new("workflow-1", task_id)
    .with_tool_registry(registry);
Source

pub fn tool_registry(&self) -> Option<&Arc<ToolRegistry>>

Returns a reference to the tool registry if set.

§Returns
  • Some(&Arc<ToolRegistry>) if tool registry is set
  • None if no tool registry
§Example
if let Some(registry) = context.tool_registry() {
    // Use tool registry
}
Source

pub fn with_audit_log(self, audit_log: AuditLog) -> Self

Sets the audit log for event recording.

§Arguments
  • audit_log - The audit log to use for event recording
§Returns

The context with audit log set (for builder pattern)

§Example
use forge_agent::audit::AuditLog;

let audit_log = AuditLog::new();
let context = TaskContext::new("workflow-1", task_id)
    .with_audit_log(audit_log);
Source

pub fn audit_log_mut(&mut self) -> Option<&mut AuditLog>

Returns a mutable reference to the audit log if set.

§Returns
  • Some(&mut AuditLog) if audit log is set
  • None if no audit log
§Example
if let Some(audit_log) = context.audit_log_mut() {
    // Use audit log
}
Source

pub fn task_timeout(&self) -> Option<Duration>

Returns the task timeout duration if set.

§Example
if let Some(timeout) = context.task_timeout() {
    println!("Task timeout: {:?}", timeout);
}

Trait Implementations§

Source§

impl Clone for TaskContext

Source§

fn clone(&self) -> TaskContext

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

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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