Enum GigasttError 

#[non_exhaustive]
pub enum GigasttError {
    ModelLoad {
        path: String,
        source: Option<Box<dyn Error + Send + Sync>>,
    },
    Inference {
        source: Box<dyn Error + Send + Sync>,
    },
    InvalidAudio {
        reason: String,
    },
    Io(Error),
    InvalidInput {
        message: String,
    },
    Cancelled,
    AudioTooLong {
        observed_secs: f64,
        limit_secs: f64,
    },
}

Errors returned by gigastt public API methods.

This enum covers the main failure categories:

• Model loading failures (ModelLoad)
• Runtime inference errors (Inference)
• Invalid audio input (InvalidAudio)
• Filesystem / I/O errors (Io)

Matching on errors

use gigastt::error::GigasttError;

match err {
    GigasttError::ModelLoad { path, .. } => eprintln!("Model problem at {path}"),
    GigasttError::Inference { .. } => eprintln!("Inference failed"),
    GigasttError::InvalidAudio { reason } => eprintln!("Bad audio: {reason}"),
    GigasttError::Io(e) => eprintln!("I/O error: {e}"),
    _ => eprintln!("Other error"),
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ModelLoad

Model files not found or failed to load ONNX sessions.

Fields

path: String

Path to the model file or directory that failed.

source: Option<Box<dyn Error + Send + Sync>>

Underlying error, if any.

Inference

ONNX inference failed during encode, decode, or join.

Fields

source: Box<dyn Error + Send + Sync>

Underlying error.

InvalidAudio

Invalid audio input (unsupported format, excessive duration, corrupt data).

Fields

reason: String

Human-readable description of why the audio was rejected.

Io(Error)

Filesystem or I/O error.

InvalidInput

Invalid user-supplied parameter or option (not audio-specific).

Fields

message: String

Cancelled

The run was cancelled cooperatively before it finished (client disconnect, DELETE /v1/jobs/{id}, a fired shutdown signal, or the no-progress inference watchdog). The decode loop observes the abort signal at a window boundary and returns this so the pooled session is released promptly instead of running to completion. Additive: the enum is #[non_exhaustive].

AudioTooLong

The audio exceeded a duration limit and was rejected before it could exhaust memory. observed_secs is how long the decoded input turned out to be; limit_secs is the ceiling that fired. Two sources trip this: the opt-in --max-audio-secs (default 0 = unlimited), and the fixed safety ceiling that the whole-buffer paths (diarization, channels=split — including its per-channel Opus decode — and the G.722 / raw telephony codecs) keep because they must materialize the entire decoded buffer in RAM. The default streaming file path, the VAD file path, and streamed OGG/Opus are O(one window) and have no length limit. Additive: the enum is #[non_exhaustive].

Fields

observed_secs: f64

Observed decoded audio length, in seconds.

limit_secs: f64

The limit that fired, in seconds.

Implementations

impl GigasttError

pub fn code(&self) -> &'static str

Stable, machine-readable error code for wire payloads (WebSocket / SSE error events). Lets both streaming surfaces emit the same code for the same failure instead of collapsing everything to one generic string.

Trait Implementations

impl Debug for GigasttError

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

Formats the value using the given formatter.

impl Display for GigasttError

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

Formats the value using the given formatter.

impl Error for GigasttError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl From<Error> for GigasttError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<RuntimeError> for GigasttError

fn from(err: RuntimeError) -> Self

Converts to this type from the input type.