Struct CustomProviderConfig 

pub struct CustomProviderConfig {

    pub id: String,
    pub name: String,
    pub short_name: String,
    pub brand: Option<String>,
    pub enabled: bool,
    pub url: String,
    pub allow_http: bool,
    pub api_key_env: String,
    pub api_key: Option<String>,
    pub auth_header: String,
    pub auth_scheme: String,
    pub headers: BTreeMap<String, String>,
    pub plan: Option<String>,
    pub plan_path: Option<String>,
    pub cache_ttl_secs: u64,
    pub metrics: Vec<CustomMetricSpec>,
    pub texts: Vec<CustomTextSpec>,
}

A user-defined HTTP provider: one GET with a static token, projected onto the shared report shape through RFC 6901 JSON Pointers.

Everything a built-in vendor hard-codes is a field here, which is why this type validates so much more than the others: a typo in [deepseek] hits a fixed endpoint and fails loudly, while a typo here quietly sends the user’s key to the wrong host. The id doubles as the cache directory name and the --vendor selector, so it is held to the character class of the built-in slugs.

Fields

id: String

[a-z0-9][a-z0-9_-]{0,31}; unique, and never a built-in vendor’s slug.

name: String

Display name, 1 to 48 characters. Defaults to id.

short_name: String

Exactly three lowercase ASCII letters, unique across built-in vendors and other custom providers — it is the {vendor_short} bar tag.

brand: Option<String>

A built-in vendor slug whose mark supporting frontends may use. None preserves the custom provider’s short_name tag.

enabled: bool

url: String

https:// unless allow_http; never carries user:pass@.

allow_http: bool

api_key_env: String

Env var read first; "" means the inline api_key is the only source.

api_key: Option<String>

auth_header: String

The header that carries the key.

auth_scheme: String

Sent as "<scheme> <key>"; "" sends the bare key.

headers: BTreeMap<String, String>

Extra non-secret headers.

plan: Option<String>

Literal plan label.

plan_path: Option<String>

Pointer to the plan label in the response; wins over plan.

cache_ttl_secs: u64

Must be within 10..=3600.

metrics: Vec<CustomMetricSpec>

texts: Vec<CustomTextSpec>

Implementations

impl<'de> CustomProviderConfig

where CustomProviderConfig: Default,

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

where __D: Deserializer<'de>,

impl CustomProviderConfig

pub fn serialize<__S>( __self: &CustomProviderConfig, __serializer: __S, ) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

impl CustomProviderConfig

pub fn section_label(&self) -> String

The TOML locator for error messages: [[custom]] id = "mytool".

pub fn resolve_api_key(&self) -> Result<String>

Env var (when api_key_env is set) → inline api_key → a Credentials error that names the section and never the key.

pub fn cache_ttl(&self) -> Duration

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

Formats the value using the given formatter.

impl Default for CustomProviderConfig

fn default() -> Self

Returns the “default value” for a type.

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

name defaults to id, which a per-field serde default cannot express (a default sees no sibling field). The derive is routed through remote = "Self" so the fill-in happens here, on every parse path, rather than only in Config::load_from.

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

Deserialize this value from the given Serde deserializer.

impl Eq for CustomProviderConfig

impl PartialEq for CustomProviderConfig

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CustomProviderConfig

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CustomProviderConfig