Struct rutabaga_gfx::rutabaga_utils::RutabagaError

pub struct RutabagaError {
    kind: RutabagaErrorKind,
    context: Option<Error>,
}

An error generated while using this crate.

Use RutabagaError::kind to distinguish between different errors.

Examples

To create a RutabagaError, create from an anyhow::Error or a RutabagaErrorKind.

use rutabaga_gfx::RutabagaError;
use rutabaga_gfx::RutabagaErrorKind;

let error: RutabagaError = anyhow::anyhow!("test error").into();
assert!(matches!(error.kind(), &RutabagaErrorKind::Internal));

let error: RutabagaError = RutabagaErrorKind::AlreadyInUse.into();
assert!(matches!(error.kind(), &RutabagaErrorKind::AlreadyInUse));

When creating from an anyhow::Error, if an RutabagaErrorKind exists in the error chain, the created RutabagaError will respect that error kind, so feel free to use anyhow::Result and anyhow::Context::context in the code base, and only convert the result to RutabagaResult at the out most public interface.

use anyhow::Context;
use rutabaga_gfx::RutabagaResult;
use rutabaga_gfx::RutabagaErrorKind;

let res = Err::<(), _>(anyhow::anyhow!("test error"))
    .context("context 1")
    .context(RutabagaErrorKind::InvalidComponent)
    .context("context 2");
let res: RutabagaResult<()> = res.map_err(|e| e.into());
let kind = res.err().map(|e| e.kind().clone());
assert!(matches!(kind, Some(RutabagaErrorKind::InvalidComponent)));

let res = Err::<(), _>(anyhow::anyhow!("test error"))
    .context("context")
    .context(RutabagaErrorKind::InvalidComponent);
let res: RutabagaResult<()> = res.map_err(|e| e.into());
let kind = res.err().map(|e| e.kind().clone());
assert!(matches!(kind, Some(RutabagaErrorKind::InvalidComponent)));

let res = Err::<(), _>(anyhow::anyhow!("test error"))
    .context(RutabagaErrorKind::InvalidComponent)
    .context("context");
let res: RutabagaResult<()> = res.map_err(|e| e.into());
let kind = res.err().map(|e| e.kind().clone());
assert!(matches!(kind, Some(RutabagaErrorKind::InvalidComponent)));

Fields

kind: RutabagaErrorKind

context: Option<Error>

Implementations

impl RutabagaError

pub fn kind(&self) -> &RutabagaErrorKind

Trait Implementations

impl Debug for RutabagaError

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

Formats the value using the given formatter.

impl Display for RutabagaError

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

Formats the value using the given formatter.

impl Error for RutabagaError

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

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<Errno> for RutabagaError

fn from(e: NixError) -> RutabagaError

Converts to this type from the input type.

impl From<Error> for RutabagaError

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<Error> for RutabagaError

fn from(e: IoError) -> RutabagaError

Converts to this type from the input type.

impl From<NulError> for RutabagaError

fn from(e: NulError) -> RutabagaError

Converts to this type from the input type.

impl From<RutabagaErrorKind> for RutabagaError

fn from(kind: RutabagaErrorKind) -> Self

Converts to this type from the input type.

impl From<TryFromIntError> for RutabagaError

fn from(e: TryFromIntError) -> RutabagaError

Converts to this type from the input type.

impl From<Utf8Error> for RutabagaError

fn from(e: Utf8Error) -> RutabagaError

Converts to this type from the input type.