Struct ExcelError 

pub struct ExcelError {
    pub kind: ExcelErrorKind,
    /* private fields */
}

The single struct your API passes around.

It combines:

• kind – the mandatory Excel error code
• message– optional human explanation
• context– generic location†
• extra – optional, kind-specific data

† If you never need row/col you can build the value with ExcelError::from(kind), which sets context = None.

Fields

kind: ExcelErrorKind

Implementations

impl ExcelError

pub fn from_function_panic(function: &str, payload: &(dyn Any + Send)) -> Self

Convert an unwinding Rust function panic to a typed #VALUE! error.

pub fn new(kind: ExcelErrorKind) -> Self

Basic constructor (no message, no location, no extra).

pub fn message(&self) -> Option<&str>

Human-readable explanation, if supplied.

pub fn context(&self) -> Option<&ErrorContext>

Generic location metadata, if supplied.

pub fn extra(&self) -> &ExcelErrorExtra

Kind-specific data; payload-free errors return ExcelErrorExtra::None.

pub fn set_message(&mut self, message: Option<String>)

Replace or clear the explanation, retaining any other metadata.

pub fn set_context(&mut self, context: Option<ErrorContext>)

Replace or clear the location, retaining any other metadata.

pub fn set_extra(&mut self, extra: ExcelErrorExtra)

Replace or clear the kind-specific data, retaining any other metadata.

pub fn with_message<S: Into<String>>(self, msg: S) -> Self

Attach a human-readable explanation.

pub fn with_location(self, row: u32, col: u32) -> Self

Attach generic row/column coordinates.

pub fn with_origin(self, sheet: Option<String>, row: u32, col: u32) -> Self

Attach origin location where the error first occurred.

pub fn with_extra(self, extra: ExcelErrorExtra) -> Self

Attach kind-specific extra data.

pub fn from_error_string(s: &str) -> Self

pub fn new_value() -> Self

pub fn new_name() -> Self

pub fn new_div() -> Self

pub fn new_ref() -> Self

pub fn new_circ() -> Self

pub fn new_num() -> Self

pub fn new_na() -> Self

Trait Implementations

impl Clone for ExcelError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExcelError

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

Formats the value using the given formatter.

impl Display for ExcelError

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

Formats the value using the given formatter.

impl Eq for ExcelError

impl Error for ExcelError

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<ExcelError> for String

fn from(error: ExcelError) -> Self

Converts to this type from the input type.

impl From<ExcelError> for LiteralValue

fn from(error: ExcelError) -> Self

Converts to this type from the input type.

impl From<ExcelErrorKind> for ExcelError

fn from(kind: ExcelErrorKind) -> Self

Converts to this type from the input type.

impl Hash for ExcelError

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ExcelError

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<&str> for ExcelError

fn eq(&self, other: &&str) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<str> for ExcelError

fn eq(&self, other: &str) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ExcelError