Skip to main content

PathPolicy

Struct PathPolicy 

Source
pub struct PathPolicy { /* private fields */ }
Expand description

A PermissionPolicy that governs FileSystemPermissionRequests by checking whether target paths fall within allowed or protected directory trees.

Protected roots take priority: any path under a protected root is denied immediately. Paths under an allowed root are permitted. Paths outside both sets either require approval or are denied, depending on require_approval_outside_allowed.

§Example

use agentkit_tools_core::PathPolicy;

let policy = PathPolicy::new()
    .allow_root("/workspace/project")
    .read_only_root("/workspace/project/vendor")
    .protect_root("/workspace/project/.env")
    .require_approval_outside_allowed(true);

Implementations§

Source§

impl PathPolicy

Source

pub fn new() -> Self

Creates a new path policy with no roots and approval required for paths outside allowed roots.

Source

pub fn allow_root(self, root: impl Into<PathBuf>) -> Self

Adds a directory tree that filesystem operations are allowed to target.

Source

pub fn read_only_root(self, root: impl Into<PathBuf>) -> Self

Adds a directory tree that may be read or listed but not mutated.

Source

pub fn protect_root(self, root: impl Into<PathBuf>) -> Self

Adds a directory tree that filesystem operations are never allowed to target.

Source

pub fn require_approval_outside_allowed(self, value: bool) -> Self

When true (the default), paths outside allowed roots trigger an approval request instead of an outright denial.

Trait Implementations§

Source§

impl Default for PathPolicy

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PermissionPolicy for PathPolicy

Source§

fn evaluate(&self, request: &dyn PermissionRequest) -> PolicyMatch

Evaluate the request and return a match or PolicyMatch::NoOpinion.

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