Skip to main content

SubagentVisibility

Enum SubagentVisibility 

Source
pub enum SubagentVisibility {
    Attributed,
    Inline,
    Hidden,
}
Expand description

What a consumer sees of an agent’s subagents.

Attributed — the default, and no transformer at all — sends the stream as the agent emitted it. The other two exist because a client older than @ag-ui/client 0.0.59 rejects the SUBAGENT_* event types while decoding: an unknown field is tolerated, an unknown event type is not, and there is nothing a client can do about it after the fact. A producer with such consumers must not send them, and this is how it does not.

Upstream’s integrations default to inline and make the full surface opt-in. This crate defaults the other way, because a transformer that rewrites the stream is opt-in here like every other: an agent that wrote ctx.subagent(..) meant it, and silently flattening what it said is the kind of surprise the design notes argue against. Flip it per endpoint when your consumers are older:

let runner = Runner::new(MyAgent).transformer(SubagentVisibility::inline());

Variants§

§

Attributed

The full surface: the lifecycle events, and subagentRunId on everything a subagent produced.

§

Inline

The pre-subagent shape: no lifecycle events and no subagentRunId anywhere — not on events, not on the messages inside MESSAGES_SNAPSHOT or the RUN_STARTED input echo, not on the interrupts a paused run reports. A subagent’s own text arrives as the parent’s work. A *_CHUNK event that named no id is given the one its attribution resolved to, since without the attribution the consumer would resolve it differently.

A subagent’s steps are dropped rather than flattened. A step brackets its own agent’s graph, and as the parent’s it would either collide with an open step of the same name — the common shape: a parent tools step wrapping the delegation and the child’s own tools inside it — or misdescribe the parent’s graph. The lifecycle events were the child’s structure; so are its steps.

§

Hidden

Only the parent’s own events. Everything a subagent produced is dropped — including the result of a call it requested, even when the parent executed it, since a result for a call the consumer never saw is a protocol error. The converse holds too: a result answering the parent’s call is kept, untagged, whoever executed it — the consumer saw the call, and a call left unanswered in the history is what the next request would carry back.

The one thing kept is the run’s shared state. A STATE_SNAPSHOT or STATE_DELTA a subagent published describes the thread’s state, not the subagent’s work: a client that never saw it would mirror a stale state and send that back on its next request. It goes out with the tag cleared, as the parent’s.

Implementations§

Source§

impl SubagentVisibility

Source

pub fn filter(self) -> SubagentFilter

The transformer for this mode. Pointless but harmless for Attributed, which passes everything through.

Source

pub fn inline() -> SubagentFilter

The transformer for Inline.

Source

pub fn hidden() -> SubagentFilter

The transformer for Hidden.

Trait Implementations§

Source§

impl Clone for SubagentVisibility

Source§

fn clone(&self) -> SubagentVisibility

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 Copy for SubagentVisibility

Source§

impl Debug for SubagentVisibility

Source§

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

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

impl Default for SubagentVisibility

Source§

fn default() -> SubagentVisibility

Returns the “default value” for a type. Read more
Source§

impl Eq for SubagentVisibility

Source§

impl Hash for SubagentVisibility

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for SubagentVisibility

Source§

fn eq(&self, other: &SubagentVisibility) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for SubagentVisibility

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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.

§

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

§

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
§

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> 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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more