Enum ConfigLayerSource 

pub enum ConfigLayerSource {
    Mdm {
        domain: String,
        key: String,
    },
    System {
        file: AbsolutePathBuf,
    },
    EnterpriseManaged {
        id: String,
        name: String,
    },
    User {
        file: AbsolutePathBuf,
        profile: Option<String>,
    },
    Project {
        dot_codex_folder: AbsolutePathBuf,
    },
    SessionFlags,
    LegacyManagedConfigTomlFromFile {
        file: AbsolutePathBuf,
    },
    LegacyManagedConfigTomlFromMdm,
}

Variants

Mdm

Managed preferences layer delivered by MDM (macOS only).

Fields

domain: String

key: String

System

Managed config layer from a file (usually managed_config.toml).

Fields

file: AbsolutePathBuf

This is the path to the system config.toml file, though it is not guaranteed to exist.

EnterpriseManaged

Enterprise-managed config layer delivered by the cloud config bundle.

Fields

id: String

Stable identifier for the delivered layer.

name: String

Admin-facing name for the delivered layer. This is surfaced in diagnostics so users know which cloud layer needs administrator attention.

User

User config layer from $CODEX_HOME/config.toml. This layer is special in that it is expected to be:

• writable by the user
• generally outside the workspace directory

Fields

file: AbsolutePathBuf

This is the path to the user’s config.toml file, though it is not guaranteed to exist.

profile: Option<String>

Name of the selected profile-v2 config layered on top of the base user config, when this layer represents one.

Project

Path to a .codex/ folder within a project. There could be multiple of these between cwd and the project/repo root.

Fields

dot_codex_folder: AbsolutePathBuf

SessionFlags

Session-layer overrides supplied via -c/--config.

LegacyManagedConfigTomlFromFile

managed_config.toml was designed to be a config that was loaded as the last layer on top of everything else. This scheme did not quite work out as intended, but we keep this variant as a “best effort” while we phase out managed_config.toml in favor of requirements.toml.

Fields

file: AbsolutePathBuf

LegacyManagedConfigTomlFromMdm

Implementations

impl ConfigLayerSource

pub fn precedence(&self) -> i16

A settings from a layer with a higher precedence will override a setting from a layer with a lower precedence.

Trait Implementations

impl Clone for ConfigLayerSource

fn clone(&self) -> ConfigLayerSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigLayerSource

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigLayerSource

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ConfigLayerSource

impl JsonSchema for ConfigLayerSource

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 ConfigLayerSource

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ConfigLayerSource

Compares ConfigLayerSource by precedence, so A < B means settings from layer A will be overridden by settings from layer B.

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ConfigLayerSource

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ConfigLayerSource

impl TS for ConfigLayerSource

type WithoutGenerics = ConfigLayerSource

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

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 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 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 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.