Struct PluginError 

pub struct PluginError { /* private fields */ }

An initialization failure with both an SDK result code and human-readable context suitable for the game log.

The SDK ABI only returns a numeric scs_result_t. Retaining a message here lets the runtime log the actual failing subscription or plugin invariant before converting the error back to that numeric code.

Implementations

impl PluginError

pub fn new(result: SdkError, message: impl Into<String>) -> Self

Creates a framework error which maps to result at the ABI boundary.

pub const fn result(&self) -> SdkError

Returns the SDK error ultimately reported to the game.

pub fn message(&self) -> &str

Returns the explanatory text logged before initialization is rolled back.

Trait Implementations

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, formatter: &mut Formatter<'_>) -> Result

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 From<SdkError> for PluginError

fn from(result: SdkError) -> Self

Converts to this type from the input type.