Skip to main content

WorkerInvocation

Struct WorkerInvocation 

Source
pub struct WorkerInvocation {
    pub token: CapToken,
    pub task_id: TaskId,
    pub attempt: u32,
    pub agent: String,
    pub prompt: String,
    pub sink: Option<Arc<dyn OutputSink>>,
    pub cancel_token: Option<CancellationToken>,
}
Expand description

Invocation context handed to a Worker fn. Bundles token + task_id + prompt + sink.

The prompt field was added in design intent, folding the old Fn(inv, directive) directive argument into the invocation. The spawner is expected to call engine.fetch_prompt(token, task_id, attempt) in its prep step and inject the snapshot into the invocation (push form). The WorkerFn side may still re-pull if it needs to — for example to fetch the prompt for a different attempt.

The sink field was added in design intent as the formal contract for the spawner’s intake surface. A worker fn can stream intermediate events with things like inv.sink.emit(OutputEvent::Progress { .. }). Child-process spawners (ProcessSpawner, etc.) do not use sink — the child speaks the stdout protocol; InProcSpawner injects one. Even without sink, the WorkerResult returned by the fn is still folded into a Final event on the spawner side, running alongside the older return-value path.

Fields§

§token: CapToken

Capability token authorizing this attempt.

§task_id: TaskId

The task this invocation belongs to.

§attempt: u32

Attempt number within the task (used to key output events).

§agent: String

Registered agent name the WorkerFn was looked up under.

§prompt: String

The prompt/prep snapshot pulled via engine.fetch_prompt, injected here (push form) so the worker fn does not need to call back into the engine for the common case.

§sink: Option<Arc<dyn OutputSink>>

Intake: sink the worker fn uses to emit intermediate OutputEvents. Injected by InProcSpawner. None means the sink path is not wired for this invocation.

§cancel_token: Option<CancellationToken>

Upstream task cancel token — the clone of cancel_inner generated by InProcSpawner for JoinHandleWorker. Worker fns bridge this to their child futures or their SDK’s shutdown_token, propagating external cancellation all the way down. None — like sink above — means the caller path is not carrying the cancel channel.

Trait Implementations§

Source§

impl Clone for WorkerInvocation

Source§

fn clone(&self) -> WorkerInvocation

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 WorkerInvocation

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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