Enum ic_agent::agent::agent_error::AgentError

pub enum AgentError {
    InvalidReplicaUrl(String),
    TimeoutWaitingForResponse(),
    SigningError(String),
    InvalidCborData(Error),
    CannotCalculateRequestId(RequestIdError),
    CandidError(Box<dyn Send + Sync + Error>),
    UrlParseError(ParseError),
    InvalidMethodError(InvalidMethod),
    PrincipalError(PrincipalError),
    ReplicaError {
        reject_code: u64,
        reject_message: String,
    },
    HttpError(HttpErrorPayload),
    CannotUseAuthenticationOnNonSecureUrl(),
    AuthenticationError(String),
    InvalidReplicaStatus,
    RequestStatusDoneNoReply(String),
    MessageError(String),
    CustomError(Box<dyn Send + Sync + Error>),
    Leb128ReadError(Error),
    Utf8ReadError(Utf8Error),
    LookupPathAbsent(Vec<Label>),
    LookupPathUnknown(Vec<Label>),
    LookupPathError(Vec<Label>),
    InvalidRequestStatus(Vec<Label>, String),
    CertificateVerificationFailed(),
    CertificateNotAuthorized(),
    DerKeyLengthMismatch {
        expected: usize,
        actual: usize,
    },
    DerPrefixMismatch {
        expected: Vec<u8>,
        actual: Vec<u8>,
    },
    NoRootKeyInStatus(Status),
    CouldNotReadRootKey(),
    BlsInitializationFailure(),
    WalletCallFailed(String),
    WalletError(String),
    WalletUpgradeRequired(String),
    MissingReplicaTransport(),
    ResponseSizeExceededLimit(),
    TransportError(Box<dyn Error + Send + Sync>),
    CallDataMismatch {
        field: String,
        value_arg: String,
        value_cbor: String,
    },
}

An error that occurred when using the agent.

Variants

InvalidReplicaUrl(String)

The replica URL was invalid.

TimeoutWaitingForResponse()

The request timed out.

SigningError(String)

An error occurred when signing with the identity.

InvalidCborData(Error)

The data fetched was invalid CBOR.

CannotCalculateRequestId(RequestIdError)

There was an error calculating a request ID.

CandidError(Box<dyn Send + Sync + Error>)

There was an error when de/serializing with Candid.

UrlParseError(ParseError)

There was an error parsing a URL.

InvalidMethodError(InvalidMethod)

The HTTP method was invalid.

PrincipalError(PrincipalError)

The principal string was not a valid principal.

ReplicaError

Fields

reject_code: u64

The reject code returned by the replica.

reject_message: String

The rejection message.

The replica rejected the message.

HttpError(HttpErrorPayload)

The replica returned an HTTP error.

CannotUseAuthenticationOnNonSecureUrl()

Attempted to use HTTP authentication in a non-secure URL (either HTTPS or localhost).

AuthenticationError(String)

The password manager returned an error.

InvalidReplicaStatus

The status endpoint returned an invalid status.

RequestStatusDoneNoReply(String)

The call was marked done, but no reply was provided.

MessageError(String)

A string error occurred in an external tool.

CustomError(Box<dyn Send + Sync + Error>)

An error occurred in an external tool.

Leb128ReadError(Error)

There was an error reading a LEB128 value.

Utf8ReadError(Utf8Error)

A string was invalid UTF-8.

LookupPathAbsent(Vec<Label>)

The lookup path was absent in the certificate.

LookupPathUnknown(Vec<Label>)

The lookup path was unknown in the certificate.

LookupPathError(Vec<Label>)

The lookup path did not make sense for the certificate.

InvalidRequestStatus(Vec<Label>, String)

The request status at the requested path was invalid.

CertificateVerificationFailed()

The certificate verification failed.

CertificateNotAuthorized()

The certificate contained a delegation that does not include the effective_canister_id in the canister_ranges field.

DerKeyLengthMismatch

Fields

expected: usize

The expected length of the key.

actual: usize

The actual length of the key.

There was a length mismatch between the expected and actual length of the BLS DER-encoded public key.

DerPrefixMismatch

Fields

expected: Vec<u8>

The expected key prefix.

actual: Vec<u8>

The actual key prefix.

There was a mismatch between the expected and actual prefix of the BLS DER-encoded public key.

NoRootKeyInStatus(Status)

The status response did not contain a root key.

CouldNotReadRootKey()

Could not read the replica root key.

BlsInitializationFailure()

Failed to initialize the BLS library.

WalletCallFailed(String)

The invocation to the wallet call forward method failed with an error.

WalletError(String)

The wallet operation failed.

WalletUpgradeRequired(String)

The wallet canister must be upgraded. See dfx wallet upgrade

MissingReplicaTransport()

The transport was not specified in the AgentBuilder.

ResponseSizeExceededLimit()

The response size exceeded the provided limit.

TransportError(Box<dyn Error + Send + Sync>)

An unknown error occurred during communication with the replica.

CallDataMismatch

Fields

field: String

The field that was mismatched.

value_arg: String

The value that was expected to be in the CBOR.

value_cbor: String

The value that was actually in the CBOR.

There was a mismatch between the expected and actual CBOR data during inspection.

Trait Implementations

impl Debug for AgentError

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

Formats the value using the given formatter.

impl Display for AgentError

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

Formats the value using the given formatter.

impl Error for AgentError

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

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, demand: &mut Demand<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type based access to context intended for error reports.

impl From<Box<dyn Error + Sync + Send + 'static, Global>> for AgentError

fn from(source: Box<dyn Send + Sync + Error>) -> Self

Converts to this type from the input type.

impl From<Error> for AgentError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for AgentError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<InvalidMethod> for AgentError

fn from(source: InvalidMethod) -> Self

Converts to this type from the input type.

impl From<ParseError> for AgentError

fn from(source: ParseError) -> Self

Converts to this type from the input type.

impl From<PrincipalError> for AgentError

fn from(source: PrincipalError) -> Self

Converts to this type from the input type.

impl From<RequestIdError> for AgentError

fn from(source: RequestIdError) -> Self

Converts to this type from the input type.

impl From<Utf8Error> for AgentError

fn from(source: Utf8Error) -> Self

Converts to this type from the input type.

impl PartialEq<AgentError> for AgentError

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.