Skip to main content

ExtensionEventName

pi::extensions

Enum ExtensionEventName 

Source 
pub enum ExtensionEventName {

Show 29 variants    Startup,
    Input,
    BeforeAgentStart,
    Context,
    AgentStart,
    AgentEnd,
    TurnStart,
    TurnEnd,
    MessageStart,
    MessageUpdate,
    MessageEnd,
    ToolExecutionStart,
    ToolExecutionUpdate,
    ToolExecutionEnd,
    ToolCall,
    ToolResult,
    SessionStart,
    SessionBeforeSwitch,
    SessionSwitch,
    SessionBeforeFork,
    SessionFork,
    SessionBeforeCompact,
    SessionCompact,
    ResourcesDiscover,
    ModelSelect,
    UserBash,
    SessionBeforeTree,
    SessionTree,
    SessionShutdown,

}
Expand description

Event names for the extension lifecycle.

Variants§

§

Startup

Agent startup (once per session).

§

Input

Input from the user.

§

BeforeAgentStart

Before the agent starts processing.

§

Context

Before provider call; can modify context messages.

§

AgentStart

Agent started processing.

§

AgentEnd

Agent ended processing.

§

TurnStart

Turn lifecycle start.

§

TurnEnd

Turn lifecycle end.

§

MessageStart

Message lifecycle start.

§

MessageUpdate

Message lifecycle update (assistant streaming).

§

MessageEnd

Message lifecycle end.

§

ToolExecutionStart

Tool execution start.

§

ToolExecutionUpdate

Tool execution update.

§

ToolExecutionEnd

Tool execution end.

§

ToolCall

Tool call (pre-exec; can block).

§

ToolResult

Tool result (post-exec; can modify).

§

SessionStart

Session start.

§

SessionBeforeSwitch

Session before switch.

§

SessionSwitch

Session switched.

§

SessionBeforeFork

Session before fork.

§

SessionFork

Session forked.

§

SessionBeforeCompact

Session before compact.

§

SessionCompact

Session compacted.

§

ResourcesDiscover

Resource discovery request.

§

ModelSelect

Model selection changed.

§

UserBash

User-initiated bash command.

§

SessionBeforeTree

Session before tree view.

§

SessionTree

Session tree navigation.

§

SessionShutdown

Session shutdown.

Implementations§

Source§

impl ExtensionEventName

Source

pub const fn is_informational(self) -> bool

Returns true for fire-and-forget lifecycle/telemetry events where the dispatcher doesn’t consume the handler’s response to block, cancel, or transform anything.

The per-extension deadline for these events is EXTENSION_INFO_EVENT_TIMEOUT_MS so one deadlocked extension on an info-only hook can’t stall the agent for the full EXTENSION_EVENT_TIMEOUT_MS.

Actionable events (not listed here) still use the longer budget so handlers have room to do meaningful work before a decision is made: BeforeAgentStart, Context, ToolCall, ToolResult (can modify the tool’s result payload), Input, SessionBeforeSwitch, SessionBeforeFork, SessionBeforeCompact, SessionBeforeTree, ResourcesDiscover.

Source

pub const fn default_timeout_ms(self) -> u64

Deadline this event should be dispatched with when no explicit caller-provided timeout is in play. See Self::is_informational.

Trait Implementations§

Source§

impl Clone for ExtensionEventName

Source§

fn clone(&self) -> ExtensionEventName

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

impl Debug for ExtensionEventName

Source§

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

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

impl Display for ExtensionEventName

Source§

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

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

impl PartialEq for ExtensionEventName

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 Copy for ExtensionEventName

Source§

impl Eq for ExtensionEventName

Source§

impl StructuralPartialEq for ExtensionEventName

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

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

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

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

Source§

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

Checks if this value is equivalent to the given key. 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: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
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> ToCompactString for T
where T: Display,

Source§

fn to_compact_string(&self) -> CompactString

Converts the given value to a CompactString. 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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<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
Source§

impl<T> ParallelSend for T

Source§

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

Source§

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