Enum AlgorithmError 

#[non_exhaustive]
pub enum AlgorithmError {
    #[non_exhaustive]
    InvalidConfiguration {
        reason: String,
    },
    #[non_exhaustive]
    NoPath {
        from: Address,
        to: Address,
        reason: NoPathReason,
    },
    InsufficientLiquidity,
    #[non_exhaustive]
    Timeout {
        elapsed_ms: u64,
    },
    ExactOutNotSupported,
    #[non_exhaustive]
    SimulationFailed {
        component_id: String,
        error: String,
    },
    #[non_exhaustive]
    DataNotFound {
        kind: &'static str,
        id: Option<String>,
    },
    Other(String),
}

Errors that can occur during route finding.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

#[non_exhaustive]

InvalidConfiguration

Invalid algorithm configuration (programmer error).

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

reason: String

Human-readable description of the invalid configuration.

#[non_exhaustive]

NoPath

No path exists between the tokens.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

from: Address

Input token address.

to: Address

Output token address.

reason: NoPathReason

Detailed reason why no path was found.

InsufficientLiquidity

Paths exist but none have sufficient liquidity.

#[non_exhaustive]

Timeout

Route finding timed out.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

elapsed_ms: u64

Elapsed time in milliseconds when the timeout fired.

ExactOutNotSupported

Exact-out not supported by this algorithm.

#[non_exhaustive]

SimulationFailed

Simulation failed for a specific component.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

component_id: String

ID of the component (liquidity pool) that failed.

error: String

Underlying simulation error message.

#[non_exhaustive]

DataNotFound

Required data not found in market.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

kind: &'static str

Category of the missing data (e.g. "token", "component").

id: Option<String>

Optional identifier of the missing item.

Other(String)

Other algorithm-specific error.

Implementations

impl AlgorithmError

Constructors for the variants that carry fields.

Those variants are #[non_exhaustive], so a crate outside this one cannot build them with a struct expression. This is how an algorithm implemented elsewhere reports what it found.

pub fn no_path(from: Address, to: Address, reason: NoPathReason) -> Self

No path exists between the two tokens.

pub fn timeout(elapsed_ms: u64) -> Self

The search ran out of time.

pub fn simulation_failed( component_id: impl Into<String>, error: impl Into<String>, ) -> Self

A component refused a swap.

pub fn data_not_found(kind: &'static str, id: impl Into<Option<String>>) -> Self

The market does not hold something the algorithm needs.

pub fn invalid_configuration(reason: impl Into<String>) -> Self

The algorithm was built with settings it cannot work under.

Trait Implementations

impl Clone for AlgorithmError

fn clone(&self) -> AlgorithmError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AlgorithmError

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

Formats the value using the given formatter.

impl Display for AlgorithmError

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

Formats the value using the given formatter.

impl Error for AlgorithmError

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<AlgorithmError> for SolverBuildError

fn from(source: AlgorithmError) -> Self

Converts to this type from the input type.

impl From<AlgorithmError> for QuoteStatus

fn from(err: AlgorithmError) -> Self

Converts to this type from the input type.

impl From<RouteValidationError> for AlgorithmError

fn from(error: RouteValidationError) -> Self

Converts to this type from the input type.

impl PartialEq for AlgorithmError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AlgorithmError