Struct SourceError

pub struct SourceError { /* private fields */ }

Struct that wraps errors from Source.

Implementations

impl SourceError

pub const fn by_reason(reason: SourceErrorReason) -> Self

Constructs SourceError by choosing a reason.

Examples

let err = SourceError::by_reason(SourceErrorReason::Open);
assert_eq!(
    format!("{}", err),
    "error occurred while reading <unknown>. reason: cannot open file."
);

pub const fn from_unknown() -> Self

Constructs SourceError with unknown (hidden) reason.

Examples

let err = SourceError::from_unknown();
assert_eq!(
    format!("{}", err),
    "error occurred while reading <unknown>. reason: unknown I/O error."
);

pub fn from_io_error<E: Error + 'static>(e: E) -> Self

Constructs SourceError from an io::Error.

Examples

let err = SourceError::from_io_error(io::Error::new(io::ErrorKind::Other, "oh no!"));
assert_eq!(
    format!("{}", err),
    "error occurred while reading <unknown>. reason: I/O error: oh no!."
);

pub fn set_path<P: AsRef<Path>>(self, path: P) -> Self

Set path as the source name (informative when Source is file-based.)

Examples

let err = SourceError::by_reason(SourceErrorReason::Open);
let err = err.set_path("missing.wav");
assert_eq!(
    format!("{}", err),
    "error occurred while reading missing.wav. reason: cannot open file."
);

Trait Implementations

impl Clone for SourceError

fn clone(&self) -> SourceError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceError

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

Formats the value using the given formatter.

impl Display for SourceError

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

Formats the value using the given formatter.

impl Error for SourceError

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<SourceError> for EncodeError

fn from(e: SourceError) -> Self

Converts to this type from the input type.