Struct AurumEngine 

pub struct AurumEngine { /* private fields */ }

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

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) -> Self

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

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 is_closed(&self) -> bool

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

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

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 (JOE-1787).

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

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

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 local TTS synthesis (JOE-1787).

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.