Skip to main content

Invocation

Struct Invocation 

Source
pub struct Invocation {
    pub targets: Vec<Target>,
    pub context: ContextScope,
    pub join: Join,
    pub executor: ExecutorHint,
    pub tools: ToolPolicy,
}
Expand description

One agent dispatch — synchronous or asynchronous, single or fan-out, local or remote. The orchestrator validates this at the entry point and then stamps the resolved fields onto the child task row(s).

Fields§

§targets: Vec<Target>

1..N targets. Join::Single requires exactly 1; the others accept any positive count.

§context: ContextScope

What the child task sees on its first turn.

§join: Join

How the parent waits.

§executor: ExecutorHint

Which orchestrator runs the agent loop. Auto resolves at invocation time from (agent.runtime ∩ caller.runtime ∩ available runners). Force is for tests and debugging.

§tools: ToolPolicy

Tool inheritance policy for the child. Defaults to Inherit (external = ["*"] — child borrows the parent session’s full external tool pool, like claude-code’s useExactTools).

Implementations§

Source§

impl Invocation

Source

pub fn validate(&self) -> Result<(), InvocationValidationError>

One-shot validation called at the orchestrator’s entry point. Downstream code can assume the invariants below hold:

  • targets.len() >= 1
  • Join::Singletargets.len() == 1
  • every target has a non-empty agent identity
Source§

impl Invocation

Source

pub fn single(target: Target) -> Self

Build a Join::Single invocation. The simplest path; matches today’s default call_agent({agent, prompt}).

Source

pub fn all(targets: Vec<Target>) -> Self

Build a Join::All fan-out.

Source

pub fn detached(targets: Vec<Target>) -> Self

Build a Join::Detached fire-and-forget. Cancellation cascades from the parent (no opt-out yet).

Source

pub fn with_context(self, context: ContextScope) -> Self

Builder: set context scope.

Source

pub fn with_executor(self, executor: ExecutorHint) -> Self

Builder: set executor hint.

Source

pub fn with_tools(self, tools: ToolPolicy) -> Self

Builder: set tool policy.

Trait Implementations§

Source§

impl Clone for Invocation

Source§

fn clone(&self) -> Invocation

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 Invocation

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Invocation

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Invocation

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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