Enum PluginError 

pub enum PluginError {
    UnsupportedVerb(Verb),
    InvalidArgs(String),
    Other(String),
}

The errors a plugin can report. Deliberately only three – because the host only needs to distinguish three: the verb is not supported (so it can degrade to passing through verbatim), the arguments are wrong, and everything else. The human-readable description goes in the payload and the host prints it to stderr as-is.

Variants

UnsupportedVerb(Verb)

This backend does not support that verb. For pmpx exec the host degrades to passing through verbatim.

InvalidArgs(String)

Invalid arguments.

Other(String)

Anything else. Includes a plugin panic – the host only needs to know “it blew up”.

Implementations

impl PluginError

pub fn unsupported_verb(verb: Verb) -> Self

Construct “unsupported verb”.

pub fn invalid_args(message: impl Into<String>) -> Self

Construct “invalid arguments”.

pub fn other(message: impl Into<String>) -> Self

Construct some other error.

pub fn code(&self) -> u32

The corresponding cross-boundary error code.

pub fn message(&self) -> String

Human-readable description.

Trait Implementations

impl Clone for PluginError

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 PluginError

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

Formats the value using the given formatter.

impl Display for PluginError

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

Formats the value using the given formatter.

impl Eq for PluginError

impl Error for PluginError

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<&str> for PluginError

fn from(message: &str) -> Self

Converts to this type from the input type.

impl From<Error> for PluginError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<String> for PluginError

fn from(message: String) -> Self

Converts to this type from the input type.

impl PartialEq for PluginError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PluginError