Skip to main content

Event

Enum Event 

Source
pub enum Event {
    Notify,
    Done,
    Idle,
    Working,
    Unknown(String),
}
Expand description

Lifecycle state the producing hook reported for a session.

On the wire this is a plain JSON string — the four known values (notify, done, working, idle) round-trip through their named variants, and anything else is preserved verbatim in Unknown(String) so new hook event types added by future agents don’t break older binaries. The variant order matches the switcher’s display priority (most-attention-needing first): Notify, Done, Idle, Working, Unknown.

Variants§

§

Notify

Agent explicitly signals the user (Claude Code Notification / PermissionRequest, pi before_user_input analogues).

§

Done

Agent just finished a turn (Claude Code Stop, pi agent_end).

§

Idle

Session is alive but not interacting (Claude Code SessionStart placeholder, pi session_start).

§

Working

Agent is in the middle of working — typing, calling tools (Claude Code UserPromptSubmit / PreToolUse, pi before_agent_start / tool_execution_start).

§

Unknown(String)

Forward-compat: a hook reported an event string we don’t recognize. Kept verbatim so re-serialization is lossless.

Implementations§

Source§

impl Event

Source

pub fn as_str(&self) -> &str

Borrow this event as the wire string the hooks use.

Source

pub fn needs_attention(&self) -> bool

Whether this event represents a session asking for the user’s eyes right now. Notify is an explicit “blocked on you” signal; Done is the just-finished state the next prompt will move on from. Any future / unknown event value is treated as attention-worthy so a new hook type added by an agent does not silently disappear from the tmux indicator. Working and Idle are alive-but-not-asking.

Trait Implementations§

Source§

impl Clone for Event

Source§

fn clone(&self) -> Event

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 Event

Source§

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

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

impl<'de> Deserialize<'de> for Event

Source§

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

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

impl Eq for Event

Source§

impl From<&str> for Event

Source§

fn from(s: &str) -> Self

Converts to this type from the input type.
Source§

impl From<String> for Event

Source§

fn from(s: String) -> Self

Converts to this type from the input type.
Source§

impl Hash for Event

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 Event

Source§

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

Source§

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Event

Auto Trait Implementations§

§

impl Freeze for Event

§

impl RefUnwindSafe for Event

§

impl Send for Event

§

impl Sync for Event

§

impl Unpin for Event

§

impl UnsafeUnpin for Event

§

impl UnwindSafe for Event

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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.