Struct Error 

pub struct Error {
    pub code: ErrorCode,
    pub message: String,
}

Error

Public-facing error DTO returned across the canister API boundary. Encodes a stable error code and a human-readable message.

Fields

code: ErrorCode

message: String

Implementations

impl Error

pub const fn new(code: ErrorCode, message: String) -> Self

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

409 – Conflict with existing state or resource.

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

403 – Authenticated caller is not permitted to perform this action.

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

500 – Internal or unexpected failure.

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

400 – Invalid input or malformed request.

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

500 – Broken invariant or impossible internal state.

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

429 / 507 – Resource, quota, or capacity exhaustion.

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

404 – Requested resource was not found.

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

401 – Caller is unauthenticated or has an invalid identity.

Trait Implementations

impl CandidType for Error

fn _ty() -> Type

fn id() -> TypeId

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

where __S: Serializer,

fn ty() -> Type

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Error

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Error

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

Formats the value using the given formatter.

impl From<AccessError> for Error

fn from(err: AccessError) -> Self

Converts to this type from the input type.

impl PartialEq for Error

fn eq(&self, other: &Error) -> 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 Error

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Error

impl StructuralPartialEq for Error