Skip to main content

Config

Struct Config 

Source
pub struct Config {
Show 30 fields pub provider: String, pub model: Option<String>, pub language: String, pub output: String, pub output_file: Option<PathBuf>, pub timestamps: bool, pub verbose: bool, pub openrouter_api_key: Option<SecretString>, pub openrouter_base_url: String, pub openrouter_default_model: String, pub openrouter_allow_custom_endpoint: bool, pub openrouter_stt_mode: String, pub openrouter_use_system_proxy: bool, pub providers: ProvidersConfig, pub cleanup_style: String, pub cleanup_provider: String, pub cleanup_openrouter_model: Option<String>, pub tts_provider: String, pub tts_model: String, pub tts_voice: String, pub tts_language: String, pub tts_speaking_rate: f32, pub tts_max_chars: usize, pub tts_timeout_ms: u64, pub tts_pack_dir: Option<PathBuf>, pub tts_allow_unverified: bool, pub tts_custom_models: Vec<CustomTtsModelConfig>, pub local_only: bool, pub config_path: Option<PathBuf>, pub cache_dir: PathBuf,
}
Expand description

Fully-resolved runtime configuration after merging all sources.

STT direction uses provider / model / language. TTS uses tts_*. OpenRouter options remain on the historical openrouter_* fields (mirrors of [providers.openrouter] / legacy [openrouter]). Other vendors live under Config::providers so the flat surface does not grow per vendor.

Fields§

§provider: String

STT provider id (local, openrouter, …). Never inferred from key presence.

§model: Option<String>§language: String§output: String§output_file: Option<PathBuf>§timestamps: bool§verbose: bool§openrouter_api_key: Option<SecretString>

OpenRouter API key — redacted via SecretString (JOE-1779).

§openrouter_base_url: String§openrouter_default_model: String§openrouter_allow_custom_endpoint: bool

Allow custom credentialed endpoints (JOE-1587).

§openrouter_stt_mode: String

auto | chat | transcriptions (JOE-1586).

§openrouter_use_system_proxy: bool§providers: ProvidersConfig

Named non-OpenRouter provider credentials (JOE-1935).

§cleanup_style: String

Cleanup style name (raw, clean, …).

§cleanup_provider: String

Cleanup backend name (rules, openrouter).

§cleanup_openrouter_model: Option<String>

Optional dedicated model for OpenRouter cleanup.

§tts_provider: String

TTS provider name (default local).

§tts_model: String§tts_voice: String§tts_language: String§tts_speaking_rate: f32§tts_max_chars: usize§tts_timeout_ms: u64§tts_pack_dir: Option<PathBuf>

Optional default pack directory for local override (JOE-1619).

§tts_allow_unverified: bool§tts_custom_models: Vec<CustomTtsModelConfig>

Validated custom TTS catalogue entries (empty when packs not present yet).

§local_only: bool

When true, remote STT/TTS providers are rejected at validation (JOE-1935).

§config_path: Option<PathBuf>§cache_dir: PathBuf

Implementations§

Source§

impl Config

Source

pub fn default_config_path() -> Option<PathBuf>

Resolve the platform-appropriate config file path.

Source

pub fn default_cache_dir() -> Result<PathBuf>

Resolve the platform-appropriate cache directory (models live under models/).

Source

pub fn load() -> Result<Self>

Load config file from the default location (if present) and merge with env vars.

Source

pub fn load_from(path: &Path) -> Result<Self>

Load from an explicit config file path (used in tests / CLI --config).

Source

pub fn load_from_required(path: &Path) -> Result<Self>

Load from an explicit path; error if the file is missing (JOE-1608).

Source

pub fn openrouter_api_key_exposed(&self) -> Option<String>

Expose the OpenRouter API key as a plain string for provider construction.

Source

pub fn provider_secret(&self, id: &ProviderId) -> Option<SecretString>

Provider-scoped secret for build-context construction (JOE-1935).

Source

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

Validate provider/model/style/limit cross-fields (JOE-1608 / JOE-1935).

Source

pub fn validate_tts_custom_models(&self) -> Result<()>

Validate [[tts.custom_models]] uniqueness and reserved namespaces.

Source

pub fn effective_diagnostic(&self) -> EffectiveConfigDiagnostic

Redacted diagnostic view for --print-effective-config (JOE-1608 / JOE-1935).

Source

pub fn apply_cli( &mut self, provider: Option<&str>, model: Option<&str>, language: Option<&str>, output: Option<&str>, output_file: Option<&Path>, timestamps: bool, verbose: bool, cleanup: Option<&str>, cleanup_provider: Option<&str>, cleanup_model: Option<&str>, )

Apply CLI overrides on top of the loaded config.

Source

pub fn resolve_model(&self, model_explicitly_set: bool) -> Result<String>

Resolve the effective model for the active provider.

Trait Implementations§

Source§

impl AsRef<Config> for ValidatedConfig

Source§

fn as_ref(&self) -> &Config

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Config

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more