Struct EnvironmentManager 

pub struct EnvironmentManager { /* private fields */ }

Owns the execution/filesystem environments available to the Codex runtime.

EnvironmentManager is a shared registry for concrete environments. Its default constructor preserves the legacy CODEX_EXEC_SERVER_URL behavior while configured construction accepts a provider-supplied snapshot.

Setting CODEX_EXEC_SERVER_URL=none disables environment access by leaving the default environment unset and omitting the local environment. Callers use default_environment().is_some() as the signal for model-facing shell/filesystem tool availability.

Remote environments begin connecting when added to the manager. Their filesystem and execution backends share that startup result and reconnect after later disconnects as needed.

Implementations

impl EnvironmentManager

pub fn default_for_tests() -> Self

Builds a test-only manager without configured sandbox helper paths.

pub fn without_environments() -> Self

Builds a manager with no configured execution environments.

pub async fn create_for_tests( exec_server_url: Option<String>, local_runtime_paths: Option<ExecServerRuntimePaths>, ) -> Self

Builds a test-only manager from a raw exec-server URL value.

pub async fn from_codex_home( codex_home: impl AsRef<Path>, local_runtime_paths: Option<ExecServerRuntimePaths>, ) -> Result<Self, ExecServerError>

Builds a manager from CODEX_HOME and local runtime paths used when creating local filesystem helpers.

If CODEX_HOME/environments.toml is present, it defines the configured environments. Otherwise this preserves the legacy CODEX_EXEC_SERVER_URL behavior.

pub async fn from_env( local_runtime_paths: Option<ExecServerRuntimePaths>, ) -> Result<Self, ExecServerError>

Builds a manager from the legacy environment-variable provider without reading user config files from CODEX_HOME.

pub async fn create_for_tests_with_local( exec_server_url: Option<String>, local_runtime_paths: ExecServerRuntimePaths, ) -> Self

Builds a test-only manager that keeps the provider default while also allowing tests to select the local environment explicitly.

pub fn default_environment(&self) -> Option<Arc<Environment>>

Returns the default environment instance.

pub fn default_environment_id(&self) -> Option<&str>

Returns the id of the default environment.

pub fn default_environment_ids(&self) -> Vec<String>

Returns the ordered environment ids used for new thread startup.

pub fn try_local_environment(&self) -> Option<Arc<Environment>>

Returns the local environment instance when one is configured.

pub fn get_environment(&self, environment_id: &str) -> Option<Arc<Environment>>

Returns a named environment instance.

pub async fn get_environment_status( &self, environment_id: &str, ) -> Option<EnvironmentObservedStatus>

Returns the current status of one named environment when it is configured.

pub fn upsert_environment( &self, environment_id: String, exec_server_url: String, connect_timeout: Option<Duration>, ) -> Result<(), ExecServerError>

Adds or replaces a named remote environment without changing the manager’s default environment selection. Uses the default WebSocket connection timeout when none is provided.

pub fn register_deferred_noise_environment( &self, environment_id: String, provider: Arc<dyn NoiseRendezvousConnectProvider>, ) -> Result<DeferredEnvironmentRegistration, ExecServerError>

Adds or replaces a Noise rendezvous environment that will become ready later.

pub fn upsert_noise_environment( &self, environment_id: String, provider: Arc<dyn NoiseRendezvousConnectProvider>, ) -> Result<(), ExecServerError>

Adds or replaces a named remote environment that connects through an authenticated, end-to-end encrypted rendezvous stream.

The provider is retained so every reconnect obtains fresh authorization. This transport never falls back to the URL-only remote environment path.

impl EnvironmentManager

pub fn inspect_selected_capability_roots( &self, selected_roots: &[SelectedCapabilityRoot], ) -> SelectedCapabilityRootsStatus

Inspects selected roots without starting or waiting for an environment.

Starting or recovering environments are omitted. Missing environments and terminal connection failures are returned as warnings so read-only catalog clients can distinguish them from an empty catalog.

Environment IDs are stable identities, so callers can safely resolve a returned root by ID when they read it.

pub async fn resolve_selected_capability_roots( &self, selected_roots: &[SelectedCapabilityRoot], captured_environments: &HashMap<String, Option<Arc<Environment>>>, ) -> Vec<ResolvedSelectedCapabilityRoot>

Resolves selected roots whose stable environments are ready for the current model step.

Environment identity comes from the selected root’s stable environment ID. A ready environment captured for the step carries its exact process-local handle so readiness and execution cannot come from different registry snapshots. Missing, starting, or failed environments are omitted. A lazy environment is started for a later step.

Trait Implementations

impl Debug for EnvironmentManager

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

Formats the value using the given formatter.