Skip to main content

FileSystemToolPolicy

Struct FileSystemToolPolicy 

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

Policy governing session-scoped filesystem access rules.

Policies are enforced by FileSystemToolResources on a per-session basis. The primary policy today is require_read_before_write, which prevents an agent from mutating a path it has not first inspected (via read or list).

§Example

use agentkit_tool_fs::FileSystemToolPolicy;

let policy = FileSystemToolPolicy::new()
    .require_read_before_write(true);

Implementations§

Source§

impl FileSystemToolPolicy

Source

pub fn new() -> Self

Creates a new policy with all rules disabled.

Source

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

When enabled, the agent must read (or list) a path before it can write, replace, move, or delete it. This helps prevent accidental overwrites.

Defaults to false.

Trait Implementations§

Source§

impl Clone for FileSystemToolPolicy

Source§

fn clone(&self) -> FileSystemToolPolicy

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 FileSystemToolPolicy

Source§

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

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

impl Default for FileSystemToolPolicy

Source§

fn default() -> FileSystemToolPolicy

Returns the “default value” for a type. 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.