Struct CandidCallError 

#[non_exhaustive]
pub struct CandidCallError {
    pub message: String,
    pub kind: CandidCallErrorKind,
    pub context: Option<Box<CandidCallContext>>,
    pub reject_response: Option<Box<RejectResponse>>,
}

CandidCallError

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

message: String

kind: CandidCallErrorKind

context: Option<Box<CandidCallContext>>

reject_response: Option<Box<RejectResponse>>

Implementations

impl CandidCallError

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

Capture one PocketIC call/codec failure.

pub fn encode(context: CandidCallContext, source: impl Display) -> Self

Capture one contextual Candid encode failure.

pub fn decode( context: CandidCallContext, bytes: usize, source: impl Display, ) -> Self

Capture one contextual Candid decode failure.

pub fn canister_reject( context: CandidCallContext, response: RejectResponse, ) -> Self

Capture one structured rejection returned by PocketIC.

pub fn transport(context: CandidCallContext, source: impl Display) -> Self

Capture one contextual PocketIC transport failure.

pub fn message(&self) -> &str

Read the rendered error message.

pub const fn kind(&self) -> CandidCallErrorKind

Read the structured failure kind.

pub fn context(&self) -> Option<&CandidCallContext>

Read the structured call context, when available.

pub fn reject_response(&self) -> Option<&RejectResponse>

Read the structured PocketIC rejection, when the call reached the IC.

Trait Implementations

impl Clone for CandidCallError

fn clone(&self) -> CandidCallError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CandidCallError

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

Formats the value using the given formatter.

impl Display for CandidCallError

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

Formats the value using the given formatter.

impl Eq for CandidCallError

impl Error for CandidCallError

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 CandidCallError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CandidCallError