Struct AurumEngine 

pub struct AurumEngine { /* private fields */ }

Library-facing engine: validated config + owned governor/metrics/model pools + registry.

Implementations

impl AurumEngine

pub fn new(config: ValidatedConfig) -> Self

Build from an already-validated config with default governor settings.

pub fn with_governor( config: ValidatedConfig, gov: GovernorConfig, ) -> Result<Self>

Build with an explicit governor profile (mobile/server/custom).

Validates gov before construction (JOE-1917 / F-004).

pub fn with_governor_and_registry( config: ValidatedConfig, gov: GovernorConfig, registry: ProviderRegistry, ) -> Result<Self>

Build with an explicit governor and provider registry (tests / embedders).

pub fn load() -> Result<Self>

Load config from the default file/env path and validate.

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

Load from an explicit config file path (must exist).

pub fn from_config(cfg: Config) -> Result<Self>

Validate a raw Config and wrap it.

pub fn config(&self) -> &Config

pub fn validated_config(&self) -> &ValidatedConfig

pub fn governor(&self) -> &Arc<ResourceGovernor>

pub fn metrics(&self) -> &Arc<Metrics>

pub fn stt_pool(&self) -> &Arc<SttContextPool>

pub fn tts_pool(&self) -> &Arc<TtsSessionPool>

pub fn registry(&self) -> &ProviderRegistry

Immutable provider registry owned by this engine (JOE-1938).

pub fn is_closed(&self) -> bool

pub fn build_context_for(&self, id: &ProviderId) -> Result<ProviderBuildContext>

Assemble a single-provider build context from engine config + pools (JOE-1938).

Secrets are scoped to id only via Config::provider_secret.

pub fn build_context_for_with( &self, id: &ProviderId, opts: ProviderResolveOptions, ) -> Result<ProviderBuildContext>

Build context with optional CLI/library overrides.

pub fn stt_provider( &self, id: &ProviderId, ) -> Result<Arc<dyn TranscriptionProvider>>

Construct an STT provider via the engine registry (JOE-1938).

pub fn stt_provider_with( &self, id: &ProviderId, opts: ProviderResolveOptions, ) -> Result<Arc<dyn TranscriptionProvider>>

pub fn tts_provider( &self, id: &ProviderId, ) -> Result<Arc<dyn SynthesisProvider>>

Construct a TTS provider via the engine registry (JOE-1938).

pub fn tts_provider_with( &self, id: &ProviderId, opts: ProviderResolveOptions, ) -> Result<Arc<dyn SynthesisProvider>>

pub fn stt_provider_id(&self) -> Result<ProviderId>

Parse config STT provider string to ProviderId.

pub fn tts_provider_id(&self) -> Result<ProviderId>

Parse config TTS provider string to ProviderId.

pub fn local_whisper(&self) -> Result<LocalWhisperProvider>

Local STT provider bound to this engine’s pool and governor (JOE-1784).

Prefer Self::stt_provider with ProviderId::local for new code.

pub fn local_tts(&self) -> Result<LocalTtsProvider>

Local TTS provider bound to this engine’s pool and governor (JOE-1784).

pub async fn transcribe( &self, input: &AudioInput, options: &TranscriptionOptions, ) -> Result<TranscriptionResult>

High-level STT from a prepared AudioInput via config provider (JOE-1787 / JOE-1938).

pub async fn transcribe_pcm( &self, samples: &[f32], options: &TranscriptionOptions, ) -> Result<TranscriptionResult>

High-level STT from mono PCM @ whisper sample rate (JOE-1787 / JOE-1938).

Builds a validated AudioInput then routes through the registry so remote providers share the same path as file-based STT.

pub async fn preload_stt(&self, model: &str) -> Result<PathBuf>

Preload a local STT model into this engine’s pool.

pub async fn synthesize( &self, text: &str, options: &SynthesisOptions, ) -> Result<SynthesisResult>

High-level TTS synthesis via config tts_provider (JOE-1787 / JOE-1938).

pub fn clear_model_caches(&self)

Drop idle model residency in this engine’s pools (JOE-1784).

pub fn shutdown(&self)

Mark the engine closed and clear idle model caches.

Does not touch process-global pools used by non-engine providers.

pub fn doctor(&self) -> DoctorReport

Read-only doctor report using this engine’s config.

pub fn support_bundle(&self, user_notes: Option<String>) -> SupportBundle

Privacy-safe support bundle using this engine’s config and engine metrics.

pub fn metrics_snapshot(&self) -> MetricsSnapshot

pub fn cache_dir(&self) -> &Path

Cache directory from validated config.

Trait Implementations

impl Debug for AurumEngine

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

Formats the value using the given formatter.

impl Drop for AurumEngine

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.