Enum FinError 

pub enum FinError {
    InvalidSymbol(String),
    InvalidPrice(Decimal),
    InvalidQuantity(Decimal),
    SequenceMismatch {
        expected: u64,
        got: u64,
    },
    InsufficientLiquidity(Decimal),
    BarInvariant(String),
    SignalNotReady {
        name: String,
        required: usize,
        have: usize,
    },
    PositionNotFound(String),
    InsufficientFunds {
        need: Decimal,
        have: Decimal,
    },
    InvalidTimeframe,
    ArithmeticOverflow,
    InvertedSpread {
        best_bid: Decimal,
        best_ask: Decimal,
    },
    InvalidPeriod(usize),
    InvalidInput(String),
}

All errors that can occur in fin-primitives operations.

Variants

InvalidSymbol(String)

Symbol string was empty or contained whitespace.

InvalidPrice(Decimal)

Price value was zero or negative.

InvalidQuantity(Decimal)

Quantity value was negative.

SequenceMismatch

Order book delta arrived out of sequence.

Fields

expected: u64

The next sequence number the book expected.

got: u64

The sequence number that was actually received.

InsufficientLiquidity(Decimal)

Not enough resting liquidity to fill the requested quantity.

BarInvariant(String)

OHLCV bar failed internal invariant check (high >= low, etc.).

SignalNotReady

A signal has not accumulated enough bars to produce a value.

Fields

name: String

Name of the signal that is not ready.

required: usize

Number of bars required before the signal produces a value.

have: usize

Number of bars seen so far.

PositionNotFound(String)

Position lookup failed for the given symbol.

InsufficientFunds

Ledger cash balance insufficient to cover the fill cost.

Fields

need: Decimal

Amount of cash required for the fill (cost + commission).

have: Decimal

Current cash balance in the ledger.

InvalidTimeframe

Timeframe duration was zero or negative.

ArithmeticOverflow

A Decimal arithmetic operation overflowed.

InvertedSpread

Order book ended up with an inverted spread after a delta was applied.

Fields

best_bid: Decimal

Best bid price at the time the spread inversion was detected.

best_ask: Decimal

Best ask price at the time the spread inversion was detected.

InvalidPeriod(usize)

Indicator or aggregator period was zero; must be at least 1.

InvalidInput(String)

General-purpose validation error for invalid inputs.

Implementations

impl FinError

pub fn is_period_error(&self) -> bool

Returns true if this error is a period validation error.

Trait Implementations

impl Debug for FinError

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

Formats the value using the given formatter.

impl Display for FinError

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

Formats the value using the given formatter.

impl Error for FinError

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.