Enum Error 

pub enum Error {
    CompileError,
    VersionMismatch {
        got: u32,
        expected: u32,
    },
    FifoBufferFull,
    NotInitialized,
    AudioError,
    VoiceNotFound(String),
    MbrolaNotFound,
    MbrolaVoiceNotFound,
    EventBufferFull,
    NotSupported,
    UnsupportedPhonFormat,
    NoSpectFrames,
    EmptyPhonemeManifest,
    SpeechStopped,
    UnknownPhonemeFeature(PhonemeFeature),
    UnknownTextEncoding(String),
    DataPath(String),
    InvalidData(String),
    NotImplemented(&'static str),
    Io(Error),
    DecodingError {
        offset: usize,
        detail: String,
    },
}

All errors that can be produced by the espeak-ng-rs library.

Variants that start with a capital letter directly correspond to espeak_ng_STATUS codes in espeak_ng.h. Variants in snake_case are Rust-native additions.

Variants

CompileError

ENS_COMPILE_ERROR — a compile error occurred in voice/dictionary data.

VersionMismatch

ENS_VERSION_MISMATCH — the data file has an unexpected version tag.

Fields

got: u32

The version tag found in the data file.

expected: u32

The version tag this build expects.

FifoBufferFull

ENS_FIFO_BUFFER_FULL — the audio FIFO buffer is full.

NotInitialized

ENS_NOT_INITIALIZED — espeak-ng has not been initialised.

AudioError

ENS_AUDIO_ERROR — audio system error.

VoiceNotFound(String)

ENS_VOICE_NOT_FOUND — the requested voice could not be found.

MbrolaNotFound

ENS_MBROLA_NOT_FOUND — the MBROLA binary is not installed.

MbrolaVoiceNotFound

ENS_MBROLA_VOICE_NOT_FOUND — the requested MBROLA voice is missing.

EventBufferFull

ENS_EVENT_BUFFER_FULL — the synthesis event queue overflowed.

NotSupported

ENS_NOT_SUPPORTED — the requested operation is not supported.

UnsupportedPhonFormat

ENS_UNSUPPORTED_PHON_FORMAT — unrecognised phoneme encoding format.

NoSpectFrames

ENS_NO_SPECT_FRAMES — no spectral frames are available for synthesis.

EmptyPhonemeManifest

ENS_EMPTY_PHONEME_MANIFEST — the phoneme manifest file is empty.

SpeechStopped

ENS_SPEECH_STOPPED — synthesis was stopped mid-utterance.

UnknownPhonemeFeature(PhonemeFeature)

ENS_UNKNOWN_PHONEME_FEATURE — the feature tag is not recognised.

UnknownTextEncoding(String)

ENS_UNKNOWN_TEXT_ENCODING — the text encoding name is not recognised.

DataPath(String)

The data path does not exist or cannot be opened.

InvalidData(String)

Invalid or corrupt binary data in an espeak-ng-data file.

NotImplemented(&'static str)

A feature of the Rust port has not been implemented yet.

The oracle comparison tests treat this as a “skip” and print the C oracle output so you can see what the implementation should produce.

Io(Error)

An I/O error occurred while reading data files.

DecodingError

The text could not be decoded with the requested encoding.

Fields

offset: usize

Byte offset in the input where the error occurred.

detail: String

Human-readable description of the error.

Trait Implementations

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, __formatter: &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<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.