Enum PermissionProfile 

pub enum PermissionProfile {
    Managed {
        file_system: ManagedFileSystemPermissions,
        network: NetworkSandboxPolicy,
    },
    Disabled,
    External {
        network: NetworkSandboxPolicy,
    },
}

Canonical active runtime permissions for a conversation, turn, or command.

Variants

Managed

Codex owns sandbox construction for this profile.

Fields

file_system: ManagedFileSystemPermissions

network: NetworkSandboxPolicy

Disabled

Do not apply an outer sandbox.

External

Filesystem isolation is enforced by an external caller.

Fields

network: NetworkSandboxPolicy

Implementations

impl PermissionProfile

pub fn read_only() -> Self

Managed read-only filesystem access with restricted network access.

pub fn workspace_write() -> Self

Managed workspace-write filesystem access with restricted network access.

The returned profile contains symbolic :project_roots entries that must be resolved against the active permission root before enforcement.

pub fn workspace_write_with( writable_roots: &[AbsolutePathBuf], network: NetworkSandboxPolicy, exclude_tmpdir_env_var: bool, exclude_slash_tmp: bool, ) -> Self

Managed workspace-write filesystem access with the legacy sandbox_workspace_write knobs applied directly to the profile.

The returned profile contains symbolic :project_roots entries that must be resolved against the active permission root before enforcement.

pub fn from_runtime_permissions( file_system_sandbox_policy: &FileSystemSandboxPolicy, network_sandbox_policy: NetworkSandboxPolicy, ) -> Self

pub fn from_runtime_permissions_with_enforcement( enforcement: SandboxEnforcement, file_system_sandbox_policy: &FileSystemSandboxPolicy, network_sandbox_policy: NetworkSandboxPolicy, ) -> Self

pub fn from_legacy_sandbox_policy(sandbox_policy: &SandboxPolicy) -> Self

pub fn from_legacy_sandbox_policy_for_cwd( sandbox_policy: &SandboxPolicy, cwd: &Path, ) -> Self

pub fn enforcement(&self) -> SandboxEnforcement

pub fn file_system_sandbox_policy(&self) -> FileSystemSandboxPolicy

pub fn network_sandbox_policy(&self) -> NetworkSandboxPolicy

pub fn to_legacy_sandbox_policy(&self, cwd: &Path) -> Result<SandboxPolicy>

pub fn to_runtime_permissions( &self, ) -> (FileSystemSandboxPolicy, NetworkSandboxPolicy)

Trait Implementations

impl Clone for PermissionProfile

fn clone(&self) -> PermissionProfile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PermissionProfile

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

Formats the value using the given formatter.

impl Default for PermissionProfile

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PermissionProfile

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for PermissionProfile

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for PermissionProfile

fn eq(&self, other: &PermissionProfile) -> 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 PermissionProfile

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 PermissionProfile

type WithoutGenerics = PermissionProfile

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 = PermissionProfile

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 PermissionProfile

impl StructuralPartialEq for PermissionProfile