Skip to main content

HookResponse

Enum HookResponse 

Source
pub enum HookResponse {
Show 20 variants ObserveOnly, InjectContext(Vec<ContextInjectionRequest>), ModifyProjection(ProjectionPatch), RequestCompaction(CompactionRequest), ModifyValidationHints(ValidationHintPatch), ModifyToolRequest(ToolRequestPatch), ModifyApprovalRequest(ApprovalRequestPatch), Deny(DenyReason), RequestApproval(ApprovalRequestPatch), RequestRetry(RetryRequest), RewriteToolResult(ToolResultPatch), ModifySubagentRequest(SubagentRequestPatch), ModifyProcessRequest(ProcessRequestPatch), ValidateDetach(DetachValidationRequest), RequestUsageRollupRepair(UsageRollupRepairRequest), RequestCleanupRepair(CleanupRepairRequest), MarkProtectedContext(Vec<ContextItemId>), RequestProjectionAuditRepair(ProjectionAuditRepairRequest), StopCompletionWithRepairNeeded(RepairNeededReason), StopRun(StopReason),
}
Expand description

Enumerates the finite hook response cases. Serialized names are part of the SDK contract; update fixtures when variants change.

Variants§

§

ObserveOnly

Use this variant when the contract needs to represent observe only; selecting it has no side effect by itself.

§

InjectContext(Vec<ContextInjectionRequest>)

Use this variant when the contract needs to represent inject context; selecting it has no side effect by itself.

§

ModifyProjection(ProjectionPatch)

Use this variant when the contract needs to represent modify projection; selecting it has no side effect by itself.

§

RequestCompaction(CompactionRequest)

Use this variant when the contract needs to represent request compaction; selecting it has no side effect by itself.

§

ModifyValidationHints(ValidationHintPatch)

Use this variant when the contract needs to represent modify validation hints; selecting it has no side effect by itself.

§

ModifyToolRequest(ToolRequestPatch)

Use this variant when the contract needs to represent modify tool request; selecting it has no side effect by itself.

§

ModifyApprovalRequest(ApprovalRequestPatch)

Use this variant when the contract needs to represent modify approval request; selecting it has no side effect by itself.

§

Deny(DenyReason)

Use this variant when the contract needs to represent deny; selecting it has no side effect by itself.

§

RequestApproval(ApprovalRequestPatch)

Use this variant when the contract needs to represent request approval; selecting it has no side effect by itself.

§

RequestRetry(RetryRequest)

Use this variant when the contract needs to represent request retry; selecting it has no side effect by itself.

§

RewriteToolResult(ToolResultPatch)

Use this variant when the contract needs to represent rewrite tool result; selecting it has no side effect by itself.

§

ModifySubagentRequest(SubagentRequestPatch)

Use this variant when the contract needs to represent modify subagent request; selecting it has no side effect by itself.

§

ModifyProcessRequest(ProcessRequestPatch)

Use this variant when the contract needs to represent modify process request; selecting it has no side effect by itself.

§

ValidateDetach(DetachValidationRequest)

Use this variant when the contract needs to represent validate detach; selecting it has no side effect by itself.

§

RequestUsageRollupRepair(UsageRollupRepairRequest)

Use this variant when the contract needs to represent request usage rollup repair; selecting it has no side effect by itself.

§

RequestCleanupRepair(CleanupRepairRequest)

Use this variant when the contract needs to represent request cleanup repair; selecting it has no side effect by itself.

§

MarkProtectedContext(Vec<ContextItemId>)

Use this variant when the contract needs to represent mark protected context; selecting it has no side effect by itself.

§

RequestProjectionAuditRepair(ProjectionAuditRepairRequest)

Use this variant when the contract needs to represent request projection audit repair; selecting it has no side effect by itself.

§

StopCompletionWithRepairNeeded(RepairNeededReason)

Use this variant when the contract needs to represent stop completion with repair needed; selecting it has no side effect by itself.

§

StopRun(StopReason)

Use this variant when the contract needs to represent stop run; selecting it has no side effect by itself.

Implementations§

Source§

impl HookResponse

Source

pub fn response_class(&self) -> HookResponseClass

Returns the response class currently held by this value. This is data-only and does not perform I/O, call host ports, append journals, publish events, or start processes.

Source

pub fn changes_behavior(&self) -> bool

Returns whether changes behavior applies for this state. This is data-only and does not perform I/O, call host ports, append journals, publish events, or start processes.

Trait Implementations§

Source§

impl Clone for HookResponse

Source§

fn clone(&self) -> HookResponse

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 HookResponse

Source§

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

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

impl<'de> Deserialize<'de> for HookResponse

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 HookResponse

Source§

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

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 Eq for HookResponse

Source§

impl StructuralPartialEq for HookResponse

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, 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> Same for T

Source§

type Output = T

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