Enum SandboxPolicy 

pub enum SandboxPolicy {
    DangerFullAccess,
    ReadOnly,
    WorkspaceWrite {
        writable_roots: Vec<PathBuf>,
        network_access: bool,
        exclude_tmpdir_env_var: bool,
        exclude_slash_tmp: bool,
        allow_git_writes: bool,
    },
}

Determines execution restrictions for model shell commands.

Variants

DangerFullAccess

No restrictions whatsoever. Use with caution.

ReadOnly

Read-only access to the entire file-system.

WorkspaceWrite

Same as ReadOnly but additionally grants write access to the current working directory (“workspace”).

Fields

writable_roots: Vec<PathBuf>

Additional folders (beyond cwd and possibly TMPDIR) that should be writable from within the sandbox.

network_access: bool

When set to true, outbound network access is allowed. false by default.

exclude_tmpdir_env_var: bool

When set to true, will NOT include the per-user TMPDIR environment variable among the default writable roots. Defaults to false.

exclude_slash_tmp: bool

When set to true, will NOT include the /tmp among the default writable roots on UNIX. Defaults to false.

allow_git_writes: bool

When true, do not protect the top-level .git folder under a writable root. Defaults to true to match historical behavior that permits Git writes.

Implementations

impl SandboxPolicy

pub fn new_read_only_policy() -> Self

Returns a policy with read-only disk access and no network.

pub fn new_workspace_write_policy() -> Self

Returns a policy that can read the entire disk, but can only write to the current working directory and the per-user tmp dir on macOS. It does not allow network access.

pub fn has_full_disk_read_access(&self) -> bool

Always returns true; restricting read access is not supported.

pub fn has_full_disk_write_access(&self) -> bool

pub fn has_full_network_access(&self) -> bool

pub fn get_writable_roots_with_cwd(&self, cwd: &Path) -> Vec<WritableRoot>

Returns the list of writable roots (tailored to the current working directory) together with subpaths that should remain read‑only under each writable root.

Trait Implementations

impl Clone for SandboxPolicy

fn clone(&self) -> SandboxPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SandboxPolicy

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SandboxPolicy

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SandboxPolicy

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

Formats the value using the given formatter.

impl FromStr for SandboxPolicy

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for SandboxPolicy

fn eq(&self, other: &SandboxPolicy) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SandboxPolicy

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for SandboxPolicy

type WithoutGenerics = SandboxPolicy

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = SandboxPolicy

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.

impl Eq for SandboxPolicy

impl StructuralPartialEq for SandboxPolicy