Skip to main content

WorkspacePolicy

Struct WorkspacePolicy 

Source
pub struct WorkspacePolicy {
    pub workspace_id: String,
    pub root: PathBuf,
    pub max_file_bytes: u64,
    pub max_output_bytes: u64,
    pub max_matches: usize,
    pub include_hidden: bool,
    pub follow_symlinks: bool,
    pub allow_create: bool,
    pub allow_overwrite: bool,
}
Expand description

Workspace workspace policy request or result value. Creating the value does not touch the filesystem; workspace executors document read, write, edit, or search effects.

Fields§

§workspace_id: String

Stable workspace id used for typed lineage, lookup, or dedupe.

§root: PathBuf

Root used by this record or request.

§max_file_bytes: u64

max file bytes used for bounds checks, summaries, or truncation evidence.

§max_output_bytes: u64

max output bytes used for bounds checks, summaries, or truncation evidence.

§max_matches: usize

Maximum number of matches to return. Use it to keep search output bounded for model context.

§include_hidden: bool

Whether include hidden is enabled. Policy, validation, or routing code uses this flag to choose the explicit behavior.

§follow_symlinks: bool

Whether follow symlinks is enabled. Policy, validation, or routing code uses this flag to choose the explicit behavior.

§allow_create: bool

Boolean policy/capability flag for whether allow create is enabled.

§allow_overwrite: bool

Boolean policy/capability flag for whether allow overwrite is enabled.

Implementations§

Source§

impl WorkspacePolicy

Source

pub fn new(root: impl Into<PathBuf>) -> Self

Creates a new workspace::policy value with explicit caller-provided inputs. This constructor is data-only and performs no I/O or external side effects.

Source

pub fn bounds_snapshot( &self, root_policy_ref: PolicyRef, ) -> WorkspaceBoundsSnapshot

Returns the bounds snapshot currently held by this value. This snapshots workspace bounds policy metadata without reading or writing workspace files.

Trait Implementations§

Source§

impl Clone for WorkspacePolicy

Source§

fn clone(&self) -> WorkspacePolicy

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for WorkspacePolicy

Source§

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

Formats the value using the given formatter. 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> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V