Enum soundio::Error

pub enum Error {
    NoMem,
    InitAudioBackend,
    SystemResources,
    OpeningDevice,
    NoSuchDevice,
    Invalid,
    BackendUnavailable,
    Streaming,
    IncompatibleDevice,
    NoSuchClient,
    IncompatibleBackend,
    BackendDisconnected,
    Interrupted,
    Underflow,
    EncodingString,
    Unknown,
}

Error is the error return type for many functions. These are taken directly from libsoundio. It supports conversion to String using the From trait.

Examples

use std::error::Error;
let e = soundio::Error::IncompatibleDevice;
println!("{}", e.description());

Variants

NoMem

Out of memory.

InitAudioBackend

The backend does not appear to be active or running.

SystemResources

A system resource other than memory was not available.

OpeningDevice

Attempted to open a device and failed.

NoSuchDevice

No device found.

Invalid

The programmer did not comply with the API.

BackendUnavailable

libsoundio was compiled without support for that backend.

Streaming

An open stream had an error that can only be recovered from by destroying the stream and creating it again.

IncompatibleDevice

Attempted to use a device with parameters it cannot support.

NoSuchClient

When JACK returns JackNoSuchClient

IncompatibleBackend

Attempted to use parameters that the backend cannot support.

BackendDisconnected

Backend server shutdown or became inactive.

Interrupted

Underflow

Buffer underrun occurred.

EncodingString

Unable to convert to or from UTF-8 to the native string format.

Unknown

Unknown error that libsoundio should never return.

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

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 description(&self) -> &str

Deprecated since 1.41.0:

use the Display impl or to_string()

if let Err(e) = "xc".parse::<u32>() { // Print e itself, no need for description(). eprintln!("Error: {}", e); }

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

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

impl From<Error> for c_int

fn from(err: Error) -> c_int

Performs the conversion.

impl From<Error> for String

fn from(err: Error) -> String

Performs the conversion.

impl From<i32> for Error

fn from(err: c_int) -> Error

Performs the conversion.