Struct CustomProviderConfig 

pub struct CustomProviderConfig {
    pub name: String,
    pub display_name: String,
    pub base_url: String,
    pub api_key_env: String,
    pub auth: Option<CustomProviderCommandAuthConfig>,
    pub model: String,
    pub models: Vec<String>,
}

Configuration for a user-defined OpenAI-compatible provider endpoint.

Allows users to define multiple named custom endpoints (e.g., corporate proxies) with distinct display names, so they can toggle between them and clearly see which endpoint is active.

Fields

name: String

Stable provider key used for routing and persistence (e.g., “mycorp”). Must be lowercase alphanumeric with optional hyphens/underscores.

display_name: String

Human-friendly label shown in the TUI header, footer, and model picker (e.g., “MyCorporateName”).

base_url: String

Base URL of the OpenAI-compatible API endpoint (e.g., <https://llm.corp.example/v1>).

api_key_env: String

Environment variable name that holds the API key for this endpoint (e.g., “MYCORP_API_KEY”).

auth: Option<CustomProviderCommandAuthConfig>

Optional command-backed bearer token configuration.

model: String

Default model to use with this endpoint (e.g., “gpt-5-mini”).

When models is empty, this single model is what the /model picker offers for this provider. When models is non-empty, this field is used as the default selection but the picker lists every entry in models.

models: Vec<String>

Optional list of additional model identifiers offered by the provider.

Useful for OpenAI-compatible aggregators such as Atlas Cloud that expose many models behind a single endpoint. When set, the /model picker shows one entry per model. When empty, the picker falls back to the single model field.

Implementations

impl CustomProviderConfig

pub fn resolved_api_key_env(&self) -> String

Resolve the API key environment variable used for this provider.

Falls back to a derived NAME_API_KEY-style variable when the config does not set api_key_env.

pub fn uses_command_auth(&self) -> bool

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

Return the list of models the /model picker should offer for this provider.

If models is non-empty, every entry is returned (trimmed). Otherwise the single model field is returned as a one-element list. An empty model field with no models list yields an empty result.

pub fn validate(&self) -> Result<(), String>

Validate that required fields are present and the name doesn’t collide with built-in provider keys.

Trait Implementations

impl Clone for CustomProviderConfig

fn clone(&self) -> CustomProviderConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CustomProviderConfig

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

Formats the value using the given formatter.

impl Default for CustomProviderConfig

fn default() -> CustomProviderConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CustomProviderConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<CustomProviderConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for CustomProviderConfig

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

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 inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for CustomProviderConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.