Struct ActionError 

#[non_exhaustive]
pub struct ActionError {
    pub code: ErrorCode,
    pub message: String,
    pub current_version: Option<i64>,
    pub fields: Vec<FieldError>,
}

A tool error object.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

code: ErrorCode

The error code.

message: String

Human-readable message.

current_version: Option<i64>

Present when code == StaleState.

fields: Vec<FieldError>

Present when code == ValidationFailed.

Implementations

impl ActionError

pub fn field(field: impl Into<String>, error: impl Into<String>) -> ActionError

Single-field validation failure (§7.3).

pub fn validation<I, F, E>(fields: I) -> ActionError

where I: IntoIterator<Item = (F, E)>, F: Into<String>, E: Into<String>,

Multi-field validation failure (§7.3).

pub fn blocked_by_modal() -> ActionError

The target window is blocked by a modal.

pub fn window_not_found() -> ActionError

The window has been closed or does not exist.

pub fn action_not_available() -> ActionError

The window-level action is currently unavailable.

pub fn action_timeout() -> ActionError

The operation timed out before landing.

pub fn stale_state(current_version: i64) -> ActionError

Version conflict (usually produced by the library; current_version is the window’s current version).

pub fn custom(code: ErrorCode, message: impl Into<String>) -> ActionError

Custom error code plus message.

Trait Implementations

impl Clone for ActionError

fn clone(&self) -> ActionError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ActionError

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

Formats the value using the given formatter.

impl Display for ActionError

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

Formats the value using the given formatter.

impl Error for ActionError

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 Serialize for ActionError

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.