Struct HookContext 

pub struct HookContext {
    pub hook_point: HookPoint,
    pub component_id: ComponentId,
    pub channel_id: ChannelId,
    pub principal: Principal,
    pub timestamp_ms: u64,
    pub payload: Value,
    pub metadata: HashMap<String, Value>,
    pub depth: u8,
    pub max_depth: u8,
}

Context passed to hook handlers.

Pre-hooks can modify payload to alter the downstream operation. Post-hooks receive the final result in payload. metadata carries cross-hook state from pre → post for the same operation.

Fields

hook_point: HookPoint

Which hook point triggered this.

component_id: ComponentId

The component targeted by this hook (from FQL match).

channel_id: ChannelId

The channel where this is happening.

principal: Principal

Who initiated the action.

timestamp_ms: u64

Monotonic timestamp (ms since engine start).

payload: Value

Hook-specific payload (varies by HookPoint).

Pre hooks: the input data (request, config, args, etc.) Post hooks: the result data (response, child_result, etc.)

metadata: HashMap<String, Value>

Mutable metadata bag — hooks can store cross-hook state here. Carried from pre → post for the same operation.

depth: u8

Recursion depth counter. Incremented each time hooks re-enter (e.g., hook calls orcs.exec() which triggers ToolPreExecute hooks).

max_depth: u8

Maximum recursion depth (default: 4).

Implementations

impl HookContext

pub fn new( hook_point: HookPoint, component_id: ComponentId, channel_id: ChannelId, principal: Principal, timestamp_ms: u64, payload: Value, ) -> Self

Creates a new HookContext with all fields specified.

pub fn with_incremented_depth(&self) -> Self

Returns a new context with depth incremented by 1.

pub fn is_depth_exceeded(&self) -> bool

Returns true if the current depth has reached or exceeded max_depth.

pub fn with_max_depth(self, max_depth: u8) -> Self

Sets the maximum recursion depth.

pub fn with_metadata(self, key: impl Into<String>, value: Value) -> Self

Adds a metadata entry.

Trait Implementations

impl Clone for HookContext

fn clone(&self) -> HookContext

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HookContext

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HookContext

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for HookContext

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.