Struct CallRejected

pub struct CallRejected { /* private fields */ }

Represents an error that occurs when an inter-canister call is rejected.

The reject_code and reject_message are exposed to provide details of the rejection.

This is wrapped by the CallFailed::CallRejected variant.

Implementations

impl CallRejected

pub fn with_rejection(raw_reject_code: u32, reject_message: String) -> Self

Constructs a CallRejected instance with the reject code and message.

Note

This constructor is primarily intended for testing scenarios where you need to simulate rejected inter-canister calls. In production code, instances of this error are typically created by the system when actual rejections occur during inter-canister communication. Use this constructor with caution outside of test environments.

pub fn reject_code(&self) -> Result<RejectCode, UnrecognizedRejectCode>

Gets the RejectCode.

The value is converted from api::msg_reject_code.

Errors

If the raw reject code is not recognized, this method will return an UnrecognizedRejectCode error. This can happen if the IC produces a new reject code that hasn’t been included in ic_error_types::RejectCode. Please check if your ic-error-types dependency is up-to-date. If the latest version of ic-error-types doesn’t include the new reject code, please report it to the ic-cdk maintainers.

pub fn raw_reject_code(&self) -> u32

Gets the raw numeric RejectCode value.

This is a “never-fail” version of reject_code that returns the raw numeric value.

pub fn reject_message(&self) -> &str

Retrieves the reject message associated with the call.

This message is obtained from api::msg_reject_msg.

Trait Implementations

impl CallErrorExt for CallRejected

fn is_clean_reject(&self) -> bool

Checks if the error is a clean reject. A clean reject means that there must be no state changes on the callee side.

fn is_immediately_retryable(&self) -> bool

Determines if the failed call can be retried immediately within the update method that’s handling the error, as opposed to relying on a background timer or heartbeat.

impl Clone for CallRejected

fn clone(&self) -> CallRejected

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CallRejected

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

Formats the value using the given formatter.

impl Display for CallRejected

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

Formats the value using the given formatter.

impl Error for CallRejected

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<CallRejected> for CallFailed

fn from(source: CallRejected) -> Self

Converts to this type from the input type.

impl From<CallRejected> for Error

fn from(source: CallRejected) -> Self

Converts to this type from the input type.