Skip to main content

HookSpecificOutput

ai_agent::hooks

Enum HookSpecificOutput

pub enum HookSpecificOutput {
Show 15 variants    PreToolUse {
        permission_decision: Option<PermissionBehavior>,
        permission_decision_reason: Option<String>,
        updated_input: Option<Value>,
        additional_context: Option<String>,
    },
    UserPromptSubmit {
        additional_context: Option<String>,
    },
    SessionStart {
        additional_context: Option<String>,
        initial_user_message: Option<String>,
        watch_paths: Option<Vec<String>>,
    },
    Setup {
        additional_context: Option<String>,
    },
    SubagentStart {
        additional_context: Option<String>,
    },
    PostToolUse {
        additional_context: Option<String>,
        updated_mcp_tool_output: Option<Value>,
    },
    PostToolUseFailure {
        additional_context: Option<String>,
    },
    PermissionDenied {
        retry: Option<bool>,
    },
    Notification {
        additional_context: Option<String>,
    },
    PermissionRequest {
        decision: Option<PermissionRequestDecision>,
    },
    Elicitation {
        action: Option<String>,
        content: Option<Value>,
    },
    ElicitationResult {
        action: Option<String>,
        content: Option<Value>,
    },
    CwdChanged {
        watch_paths: Option<Vec<String>>,
    },
    FileChanged {
        watch_paths: Option<Vec<String>>,
    },
    WorktreeCreate {
        worktree_path: String,
    },
}

Expand description

Event-specific hook output sub-schema (mirrors TS hookSpecificOutput).

Variants§

PreToolUse

Fields

§permission_decision: Option<PermissionBehavior>

§permission_decision_reason: Option<String>

§updated_input: Option<Value>

§additional_context: Option<String>

UserPromptSubmit

Fields

§additional_context: Option<String>

SessionStart

Fields

§additional_context: Option<String>

§initial_user_message: Option<String>

§watch_paths: Option<Vec<String>>

Setup

Fields

§additional_context: Option<String>

SubagentStart

Fields

§additional_context: Option<String>

PostToolUse

Fields

§additional_context: Option<String>

§updated_mcp_tool_output: Option<Value>

PostToolUseFailure

Fields

§additional_context: Option<String>

PermissionDenied

Fields

§retry: Option<bool>

Notification

Fields

§additional_context: Option<String>

PermissionRequest

Fields

§decision: Option<PermissionRequestDecision>

Elicitation

Fields

§action: Option<String>

§content: Option<Value>

ElicitationResult

Fields

§action: Option<String>

§content: Option<Value>

CwdChanged

Fields

§watch_paths: Option<Vec<String>>

FileChanged

Fields

§watch_paths: Option<Vec<String>>

WorktreeCreate

Fields

§worktree_path: String

Trait Implementations§

impl Clone for HookSpecificOutput

fn clone(&self) -> HookSpecificOutput

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

impl Debug for HookSpecificOutput

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for HookSpecificOutput

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

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for HookSpecificOutput

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§

impl Freeze for HookSpecificOutput

impl RefUnwindSafe for HookSpecificOutput

impl Send for HookSpecificOutput

impl Sync for HookSpecificOutput

impl Unpin for HookSpecificOutput

impl UnsafeUnpin for HookSpecificOutput

impl UnwindSafe for HookSpecificOutput

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

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

impl<T, U> Into<U> for T
where U: From<T>,

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

impl<T> Same for T

type Output = T

Should always be Self

impl<T> TaskStateTrait for T
where T: Clone + 'static,

fn as_any(&self) -> &(dyn Any + 'static)

fn clone_box(&self) -> Box<dyn TaskStateTrait>

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,