Enum coprocessor_plugin_api::errors::PluginError

[−] Show declaration

pub enum PluginError {
    KeyNotInRegion {
        key: Key,
        region_id: u64,
        start_key: Key,
        end_key: Key,
    },
    Timeout(Duration),
    Canceled,
    Other(Box<dyn Any>),
}

[−] Expand description

Error returned by operations on [RawStorage].

If a plugin wants to return a custom error, e.g. an error in the business logic, the plugin should return an appropriately encoded error in [RawResponse]; in other words, plugins are responsible for their error handling by themselves.

Variants

KeyNotInRegion

[−] Show fields

Fields of KeyNotInRegion

key: Keyregion_id: u64start_key: Keyend_key: Key

Timeout(Duration)

Canceled

Other(Box<dyn Any>)

[−] Expand description

Errors that can not be handled by a coprocessor plugin but should instead be returned to the client.

If such an error appears, plugins can run some cleanup code and return early from the request. The error will be passed to the client and the client might retry the request.

Trait Implementations

impl Debug for PluginError[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Display for PluginError[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Error for PluginError[+]

[+] Show hidden undocumented items

pub fn source(&self) -> Option<&(dyn Error + 'static)>[−]

The lower-level source of this error, if any.

pub fn backtrace(&self) -> Option<&Backtrace>[−]

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

pub fn description(&self) -> &str[−]

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

pub fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting