Struct VtaError 

pub struct VtaError {
    pub area: Area,
    pub number: u16,
    pub message: String,
    pub source: Option<Box<dyn Error + Send + Sync>>,
}

The structured error type returned across the workspace.

Fields

area: Area

The subsystem area.

number: u16

The stable per-area number (rendered zero-padded to four digits).

message: String

A human-readable, actionable message.

source: Option<Box<dyn Error + Send + Sync>>

An optional underlying cause.

Implementations

impl VtaError

pub fn new(area: Area, number: u16, message: impl Into<String>) -> Self

Construct an error with an area, a stable number, and a message.

pub fn with_source(self, source: impl Error + Send + Sync + 'static) -> Self

Attach an underlying cause.

pub fn code(&self) -> String

The stable code string, e.g. "VTA-CFG-0007".

pub fn exit(&self) -> ExitCode

The process exit code this error maps to.

Trait Implementations

impl Debug for VtaError

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

Formats the value using the given formatter.

impl Display for VtaError

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

Formats the value using the given formatter.

impl Error for VtaError

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.