> ## Documentation Index
> Fetch the complete documentation index at: https://praison.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Hook Result • Rust AI Agent SDK
> HookResult: Result from a hook execution
# HookResult
> Defined in the [**hooks**](../modules/hooks) module.
Rust AI Agent SDK
Result from a hook execution
```mermaid theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
%%{init: {'theme': 'base', 'themeVariables': { 'primaryColor': '#8B0000', 'primaryTextColor': '#fff', 'primaryBorderColor': '#710101', 'lineColor': '#189AB4', 'secondaryColor': '#189AB4', 'tertiaryColor': '#fff' }}}%%
graph TD
event["Event Trigger"] --> hook["Hook: HookResult"]
hook --> decision{"Decision"}
decision -- "Allow" --> proc["Process"]
decision -- "Deny" --> block["Block"]
style hook fill:#189AB4,color:#fff
style event fill:#8B0000,color:#fff
style proc fill:#8B0000,color:#fff
style block fill:#8B0000,color:#fff
```
## Fields
| Name | Type | Description |
| -------------------- | ----------------------------- | ---------------------------------- |
| `decision` | `HookDecision` | Decision (allow, deny, block, ask) |
| `reason` | `Option<String>` | Reason for the decision |
| `modified_input` | `Option<HashMap<String` | Modified input data (optional) |
| `serde_json` | `:Value>>` | Modified input data (optional) |
| `additional_context` | `Option<String>` | Additional context |
| `suppress_output` | `bool` | Whether to suppress output |
## Methods
### `allow`
```rust theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
fn allow() -> Self
```
Create an allow result
### `allow_with_reason`
```rust theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
fn allow_with_reason(reason: impl Into) -> Self
```
Create an allow result with reason
**Parameters:**
| Name | Type |
| -------- | ------------------------- |
| `reason` | `impl Into<String>` |
### `deny`
```rust theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
fn deny(reason: impl Into) -> Self
```
Create a deny result
**Parameters:**
| Name | Type |
| -------- | ------------------------- |
| `reason` | `impl Into<String>` |
### `block`
```rust theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
fn block(reason: impl Into) -> Self
```
Create a block result
**Parameters:**
| Name | Type |
| -------- | ------------------------- |
| `reason` | `impl Into<String>` |
### `ask`
```rust theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
fn ask(reason: impl Into) -> Self
```
Create an ask result
**Parameters:**
| Name | Type |
| -------- | ------------------------- |
| `reason` | `impl Into<String>` |
### `is_allowed`
```rust theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
fn is_allowed(&self) -> bool
```
Check if the result allows execution
### `is_denied`
```rust theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
fn is_denied(&self) -> bool
```
Check if the result denies execution
### `with_modified_input`
```rust theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
fn with_modified_input(mut self, input: HashMap) -> Self
```
Add modified input
**Parameters:**
| Name | Type |
| ------------ | ------------------- |
| `input` | `HashMap<String` |
| `serde_json` | `:Value>` |
### `with_context`
```rust theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
fn with_context(mut self, context: impl Into) -> Self
```
Add additional context
**Parameters:**
| Name | Type |
| --------- | ------------------------- |
| `context` | `impl Into<String>` |
### `suppress`
```rust theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
fn suppress(mut self) -> Self
```
Suppress output
## Source
`praisonai/src/hooks/mod.rs` at line 177
***
## Related Documentation