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
impl SdkError
pub fn new(code: ErrorCode, message: impl Into<String>) -> Self
Sourcepub fn with_hint(self, hint: impl Into<String>) -> Self
pub fn with_hint(self, hint: impl Into<String>) -> Self
Attach the developer-facing “what to do about it” line.
Sourcepub fn with_context(self, key: impl Into<String>, value: impl Display) -> Self
pub fn with_context(self, key: impl Into<String>, value: impl Display) -> Self
Attach a named value that was compared, read, or resolved.
Sourcepub fn error_code(&self) -> ErrorCode
pub fn error_code(&self) -> ErrorCode
Typed form of SdkError::code, for exhaustive matching in Rust.
Sourcepub fn context(&self) -> &[(String, String)]
pub fn context(&self) -> &[(String, String)]
Named values involved in the failure (compared ids, resolved paths, ports).
Sourcepub fn is_retryable(&self) -> bool
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.
Trait Implementations§
impl Eq for SdkError
Source§impl Error for SdkError
impl Error for SdkError
1.30.0 · Source§fn source(&self) -> Option<&(dyn Error + 'static)>
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
fn description(&self) -> &str
👎Deprecated since 1.42.0:
use the Display impl or to_string()
impl StructuralPartialEq for SdkError
Auto Trait Implementations§
impl Freeze for SdkError
impl RefUnwindSafe for SdkError
impl Send for SdkError
impl Sync for SdkError
impl Unpin for SdkError
impl UnsafeUnpin for SdkError
impl UnwindSafe for SdkError
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more