Enum Error

#[non_exhaustive]
pub enum Error {
    NoModel,
    InvalidAlphabet,
    InvalidShape,
    InvalidScorer,
    ModelIncompatible,
    ScorerNotEnabled,
    ScorerUnreadable,
    ScorerInvalidHeader,
    ScorerNoTrie,
    ScorerInvalidTrie,
    ScorerVersionMismatch,
    InitMmapFailed,
    InitSessionFailed,
    InterpreterFailed,
    RunSessionFailed,
    CreateStreamFailed,
    ReadProtoBufFailed,
    CreateSessionFailed,
    CreateModelFailed,
    InsertHotWordFailed,
    ClearHotWordsFailed,
    EraseHotWordFailed,
    Other(i32),
    Unknown,
    NulBytesFound,
    Utf8Error(FromUtf8Error),
}

All possible errors returned by the C API plus some Rust errors.

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.

NoModel

Missing model information.

InvalidAlphabet

Invalid alphabet embedded in model. (Data corruption?)

InvalidShape

Invalid model shape.

InvalidScorer

Invalid scorer file.

ModelIncompatible

Incompatible model.

ScorerNotEnabled

External scorer is not enabled.

ScorerUnreadable

Could not read scorer file.

ScorerInvalidHeader

Could not recognize language model header in scorer.

ScorerNoTrie

Reached end of scorer file before loading vocabulary trie.

ScorerInvalidTrie

Invalid magic in trie header.

ScorerVersionMismatch

Scorer file version does not match expected version.

InitMmapFailed

Failed to initialize memory mapped model.

InitSessionFailed

Failed to initialize the session.

InterpreterFailed

Interpreter failed.

RunSessionFailed

Failed to run the session.

CreateStreamFailed

Error creating the stream.

ReadProtoBufFailed

Error reading the proto buffer model file.

CreateSessionFailed

Failed to create session.

CreateModelFailed

Could not allocate model state.

InsertHotWordFailed

Could not insert hot-word.

ClearHotWordsFailed

Could not clear hot-words.

EraseHotWordFailed

Could not erase hot-word.

Other(i32)

An unknown error was returned.

Unknown

An unknown error was returned.

NulBytesFound

Null bytes were found in a string passed in.

Utf8Error(FromUtf8Error)

A string returned by libstt contained invalid UTF-8.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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<FromBytesWithNulError> for Error

fn from(_: FromBytesWithNulError) -> Self

Converts to this type from the input type.

impl From<FromUtf8Error> for Error

fn from(e: FromUtf8Error) -> Self

Converts to this type from the input type.