> ## 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.

# Policy Result • Rust AI Agent SDK

> PolicyResult: Result of a policy check.

# PolicyResult

> Defined in the [**policy**](../modules/policy) module.

<Badge color="orange">Rust AI Agent SDK</Badge>

Result of a policy check.

## Fields

| Name               | Type                   | Description                      |
| ------------------ | ---------------------- | -------------------------------- |
| `passed`           | `bool`                 | Whether the check passed         |
| `action`           | `PolicyAction`         | Action to take                   |
| `triggered_rule`   | `Option&lt;String&gt;` | Rule that was triggered (if any) |
| `message`          | `Option&lt;String&gt;` | Message                          |
| `modified_content` | `Option&lt;String&gt;` | Modified content (if redacted)   |

## Methods

### `pass`

```rust theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
fn pass() -> Self
```

Create a passing result.

### `block`

```rust theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
fn block(rule: impl Into<String>, message: impl Into<String>) -> Self
```

Create a blocking result.

**Parameters:**

| Name      | Type                      |
| --------- | ------------------------- |
| `rule`    | `impl Into&lt;String&gt;` |
| `message` | `impl Into&lt;String&gt;` |

### `warn`

```rust theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
fn warn(rule: impl Into<String>, message: impl Into<String>) -> Self
```

Create a warning result.

**Parameters:**

| Name      | Type                      |
| --------- | ------------------------- |
| `rule`    | `impl Into&lt;String&gt;` |
| `message` | `impl Into&lt;String&gt;` |

### `redact`

```rust theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
fn redact(rule: impl Into<String>, modified: impl Into<String>) -> Self
```

Create a redact result.

**Parameters:**

| Name       | Type                      |
| ---------- | ------------------------- |
| `rule`     | `impl Into&lt;String&gt;` |
| `modified` | `impl Into&lt;String&gt;` |

## Source

<Card title="View on GitHub" icon="github" href="https://github.com/MervinPraison/PraisonAI/blob/main/src/praisonai-rust/praisonai/src/policy/mod.rs#L53">
  `praisonai/src/policy/mod.rs` at line 53
</Card>

***

## Related Documentation

<CardGroup cols={2}>
  <Card title="Rust Policy" icon="file-shield" href="/docs/rust/policy" />

  <Card title="Rust Security" icon="lock" href="/docs/rust/security" />
</CardGroup>
