Struct CodexCapabilities 

pub struct CodexCapabilities {
    pub cache_key: CapabilityCacheKey,
    pub fingerprint: Option<BinaryFingerprint>,
    pub version: Option<CodexVersionInfo>,
    pub features: CodexFeatureFlags,
    pub probe_plan: CapabilityProbePlan,
    pub collected_at: SystemTime,
}

Snapshot of Codex CLI capabilities derived from probing a specific binary.

Instances of this type are intended to be cached per binary path so callers can gate optional flags (like --output-schema) without repeatedly spawning the CLI. A process-wide HashMap<CapabilityCacheKey, CodexCapabilities> (behind a mutex/once) keeps probes cheap; entries should use canonical binary paths where possible and ship a BinaryFingerprint so we can invalidate stale snapshots when the binary on disk changes.

Fields

cache_key: CapabilityCacheKey

Canonical path used as the cache key.

fingerprint: Option<BinaryFingerprint>

File metadata used to detect when a cached entry is stale.

version: Option<CodexVersionInfo>

Parsed output from codex --version; None when the command fails.

features: CodexFeatureFlags

Known feature toggles; fields default to false when detection fails.

probe_plan: CapabilityProbePlan

Steps attempted while interrogating the binary (version, features, help).

collected_at: SystemTime

Timestamp of when the probe finished.

Implementations

impl CodexCapabilities

pub fn guard_output_schema(&self) -> CapabilityGuard

Guards whether --output-schema should be passed to codex exec.

pub fn guard_add_dir(&self) -> CapabilityGuard

Guards whether codex add-dir can be invoked safely.

pub fn guard_mcp_login(&self) -> CapabilityGuard

Guards whether codex login --mcp is available.

pub fn guard_features_list(&self) -> CapabilityGuard

Guards whether codex features list is supported by the probed binary.

pub fn guard_feature(&self, feature: CapabilityFeature) -> CapabilityGuard

Returns a guard describing if a feature/flag is supported by the probed binary.

The guard treats missing features list support as Unknown so hosts can degrade gracefully on older binaries instead of passing unsupported flags.

Trait Implementations

impl Clone for CodexCapabilities

fn clone(&self) -> CodexCapabilities

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodexCapabilities

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CodexCapabilities

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CodexCapabilities

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CodexCapabilities

impl StructuralPartialEq for CodexCapabilities