Struct PluginError 

pub struct PluginError {
    pub code: PluginErrorCode,
    pub message: String,
}

Error type shared by the host and plugins.

Fields

code: PluginErrorCode

Stable error category.

message: String

Human-readable detail safe to return to a plugin caller.

Implementations

impl PluginError

pub fn new(code: PluginErrorCode, message: impl Into<String>) -> Self

Construct an error with a stable code.

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

Construct an invalid-input error.

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

Construct a not-found error.

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

Construct a concurrency-conflict error.

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

Construct an undeclared-capability error.

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

Construct an unavailable error.

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

Construct a call-budget-exceeded error.

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

Construct an internal error.

Trait Implementations

impl Clone for PluginError

fn clone(&self) -> PluginError

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<'de> Deserialize<'de> for PluginError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PluginError

fn fmt(&self, __formatter: &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 PartialEq for PluginError

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for PluginError

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PluginError