Skip to main content

SdkError

Struct SdkError 

Source
pub struct SdkError { /* private fields */ }
Expand description

A single SDK failure.

Match on SdkError::code — it is the stable contract. message is safe to show a player; hint and context are for the developer’s logs.

Implementations§

Source§

impl SdkError

Source

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

Source

pub fn with_hint(self, hint: impl Into<String>) -> Self

Attach the developer-facing “what to do about it” line.

Source

pub fn with_context(self, key: impl Into<String>, value: impl Display) -> Self

Attach a named value that was compared, read, or resolved.

Source

pub fn code(&self) -> &'static str

Stable machine-readable code, e.g. "not_owned".

Source

pub fn error_code(&self) -> ErrorCode

Typed form of SdkError::code, for exhaustive matching in Rust.

Source

pub fn message(&self) -> &str

Player-facing explanation, without developer detail.

Source

pub fn hint(&self) -> Option<&str>

Developer-facing next step, when one exists.

Source

pub fn context(&self) -> &[(String, String)]

Named values involved in the failure (compared ids, resolved paths, ports).

Source

pub fn is_retryable(&self) -> bool

Whether retrying the same call could succeed once an external condition changes (network comes back, Arcane opens, the player signs in) without the developer changing any code.

Source

pub fn to_json(&self) -> String

Machine-readable rendering for engines that want to surface full detail.

Trait Implementations§

Source§

impl Clone for SdkError

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SdkError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for SdkError

Source§

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

code: message — hint (key=value, key=value)

Source§

impl Eq for SdkError

Source§

impl Error for SdkError

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl PartialEq for SdkError

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SdkError

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.