Struct RemitError 

pub struct RemitError {
    pub code: String,
    pub message: String,
    pub doc_url: String,
    pub context: HashMap<String, Value>,
}

Structured error type returned by all SDK methods.

Every error has a stable machine-readable code, an actionable message that tells the agent exactly how to fix the problem, and a doc_url linking to the specific error’s remediation guide.

Matching on error codes

use remitmd::{RemitError, error::codes};

if let Err(e) = result {
    match e.code.as_str() {
        codes::INSUFFICIENT_BALANCE => println!("need more USDC: {}", e.message),
        codes::INVALID_ADDRESS => println!("bad address: {}", e.message),
        _ => println!("error: {e}"),
    }
}

Fields

code: String

Stable machine-readable code (e.g., "INVALID_ADDRESS").

message: String

Actionable message explaining the error and how to fix it.

doc_url: String

Direct link to documentation for this error code.

context: HashMap<String, Value>

Structured context values (offending input, limits, etc.).

Implementations

impl RemitError

pub fn new(code: &str, message: impl Into<String>) -> Self

pub fn with_context(self, key: &str, value: impl Into<Value>) -> Self

Trait Implementations

impl Clone for RemitError

fn clone(&self) -> RemitError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RemitError

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

Formats the value using the given formatter.

impl Display for RemitError

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

Formats the value using the given formatter.

impl Error for RemitError

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.