Struct PluginError 

pub struct PluginError {
    pub code: String,
    pub message: String,
    pub details: Option<String>,
}

Error returned by plugin method implementations to signal business logic failures.

Serialized as bincode across the FFI boundary. The host deserializes this from the output buffer when the FFI shim returns STATUS_PLUGIN_ERROR.

The details field is stored as a JSON string (not serde_json::Value) because bincode cannot deserialize a free-form serde_json::Value (it lacks deserialize_any). Storing it as a String keeps the error struct bincode-compatible.

Fields

code: String

Machine-readable error code (e.g., "INVALID_INPUT", "NOT_FOUND").

message: String

Human-readable error message.

details: Option<String>

Optional structured details as a JSON string.

Implementations

impl PluginError

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

Create a new PluginError without details.

pub fn with_details( code: impl Into<String>, message: impl Into<String>, details: Value, ) -> PluginError

Create a new PluginError with structured details.

The serde_json::Value is serialized to a JSON string for storage.

pub fn details_value(&self) -> Option<Value>

Parse the details field back into a serde_json::Value.

Returns None if details is absent or fails to parse.

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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PluginError

fn deserialize<__D>( __deserializer: __D, ) -> Result<PluginError, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PluginError

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

Formats the value using the given formatter.

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PluginError

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.

impl StructuralPartialEq for PluginError