Skip to main content

LifecycleEvent

Enum LifecycleEvent 

Source
pub enum LifecycleEvent {
Show 15 variants SessionStart { source: Option<String>, }, SessionEnd { reason: Option<String>, }, WorkingStart, WorkingEnd, Idle, PromptSubmit { prompt: Option<String>, }, NeedsInput { reason: NeedsInputReason, }, ToolCallStart { name: Tool, tool_use_id: Option<String>, input: Option<Value>, }, ToolCallEnd { name: Tool, tool_use_id: Option<String>, is_error: bool, }, ContextCompactStart { trigger: Option<String>, }, ContextUpdate { tokens: Option<u64>, cost_usd: Option<f64>, }, ProviderModelChange { provider: Option<String>, model: Option<String>, }, Notification { message: Option<String>, kind: Option<NotificationKind>, }, ChildSessionStart { id: Option<String>, role: Option<String>, }, ChildSessionEnd { id: Option<String>, },
}
Expand description

Vendor-neutral lifecycle event.

Adapters translate native vendor events into these variants; the daemon dispatches on them to update session state.

Eq is intentionally not derived: ContextUpdate carries an Option<f64> cost, which is not Eq.

Variants§

§

SessionStart

Session opened. source carries why (Claude: startup/resume/ clear; pi: startup).

Fields

§source: Option<String>
§

SessionEnd

Session closed. reason is vendor-supplied when available (pi session_shutdown.reason; Claude SessionEnd.reason).

Fields

§reason: Option<String>
§

WorkingStart

Agent began a working block. (Pi agent_start; Claude has no direct analog — synthesized from UserPromptSubmit or first PreToolUse.)

§

WorkingEnd

Agent finished a working block. (Pi agent_end; Claude Stop.)

§

Idle

Explicit idle signal. Distinct from WorkingEnd because pi can transition idle → idle (no work happened) via ctx.isIdle() && !ctx.hasPendingMessages().

§

PromptSubmit

User submitted a prompt.

Fields

§prompt: Option<String>
§

NeedsInput

Session is waiting on user input.

Fields

§

ToolCallStart

A tool started executing.

tool_use_id is the correlation id pairing this with its later ToolCallEnd (Claude tool_use_id, pi toolCallId). input is the tool arguments JSON, when the vendor exposes it.

Fields

§name: Tool
§tool_use_id: Option<String>
§input: Option<Value>
§

ToolCallEnd

A tool finished executing. tool_use_id matches the originating ToolCallStart.

Fields

§name: Tool
§tool_use_id: Option<String>
§is_error: bool
§

ContextCompactStart

Context compaction is starting. trigger is the cause (Claude: auto/manual).

Fields

§trigger: Option<String>
§

ContextUpdate

Periodic context-usage update (tokens used, accumulated cost). Either field may be None if the vendor doesn’t expose it.

Fields

§tokens: Option<u64>
§cost_usd: Option<f64>
§

ProviderModelChange

Provider or model changed mid-session (pi model_select).

Fields

§provider: Option<String>
§

Notification

Free-form notification surfaced to the user. kind carries an optional sub-type the UI can render specially.

§

ChildSessionStart

A child session (subagent / task / fork) started. id is a vendor-supplied correlation id; role is a free-form tag (e.g. Claude subagent role: "explore", "plan").

Fields

§

ChildSessionEnd

A child session finished.

Fields

Implementations§

Source§

impl LifecycleEvent

Source

pub fn is_terminal_for_turn(&self) -> bool

True if this event ends/clears the session’s working state.

Source

pub fn is_starting(&self) -> bool

True if this event opens the session’s working state.

Trait Implementations§

Source§

impl Clone for LifecycleEvent

Source§

fn clone(&self) -> LifecycleEvent

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 LifecycleEvent

Source§

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

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

impl<'de> Deserialize<'de> for LifecycleEvent

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 PartialEq for LifecycleEvent

Source§

fn eq(&self, other: &LifecycleEvent) -> 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 Serialize for LifecycleEvent

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

impl StructuralPartialEq for LifecycleEvent

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> 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<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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,