Skip to main content

PermissionResult

Enum PermissionResult 

Source
pub enum PermissionResult {
    Allow {
        updated_input: Value,
        updated_permissions: Option<Vec<Value>>,
    },
    Deny {
        message: String,
        interrupt: bool,
    },
}
Expand description

Result of a permission decision

This type represents the decision made by the permission callback. It can be serialized directly into the control response format.

Variants§

§

Allow

Allow the tool to execute

Fields

§updated_input: Value

The (possibly modified) input to pass to the tool

§updated_permissions: Option<Vec<Value>>

Optional updated permissions list

§

Deny

Deny the tool execution

Fields

§message: String

Message explaining why the tool was denied

§interrupt: bool

If true, stop the entire session

Implementations§

Source§

impl PermissionResult

Source

pub fn allow(input: Value) -> Self

Create an allow result with the given input

Source

pub fn allow_with_permissions(input: Value, permissions: Vec<Value>) -> Self

Create an allow result with raw permissions (as JSON Values).

Prefer using allow_with_typed_permissions for type safety.

Source

pub fn allow_with_typed_permissions( input: Value, permissions: Vec<Permission>, ) -> Self

Create an allow result with typed permissions.

This is the preferred way to grant permissions for “remember this decision” functionality.

§Example
use claude_codes::{Permission, PermissionResult};
use serde_json::json;

let result = PermissionResult::allow_with_typed_permissions(
    json!({"command": "npm test"}),
    vec![Permission::allow_tool("Bash", "npm test")],
);
Source

pub fn deny(message: impl Into<String>) -> Self

Create a deny result

Source

pub fn deny_and_interrupt(message: impl Into<String>) -> Self

Create a deny result that also interrupts the session

Trait Implementations§

Source§

impl Clone for PermissionResult

Source§

fn clone(&self) -> PermissionResult

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
Source§

impl Debug for PermissionResult

Source§

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

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

impl<'de> Deserialize<'de> for PermissionResult

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 Serialize for PermissionResult

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

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