Struct NotListed 

#[non_exhaustive]
pub struct NotListed {
    pub key: MarketKey,
}

The venue’s answer identifies the key as an instrument it does not list. A VenueRefusal, as the venue’s own answer for an unknown instrument is.

Not every venue says so: where its answer does not identify the instrument as unlisted, the venue’s own refusal comes through with the same class, and some venues return an empty quote or book. The guarantee is the class, so match on class(), not on this type.

A crate that depends on this one builds it with NotListed::new, since a field may be added later, and a struct literal is refused when the program is built:

use polyoxide_venue::{MarketKey, NotListed};

fn refuse(key: MarketKey) -> NotListed {
    NotListed { key }
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key: MarketKey

The key asked for.

Implementations

impl NotListed

pub fn new(key: MarketKey) -> Self

The refusal for key, an instrument the venue does not list.

Trait Implementations

impl Classify for NotListed

fn class(&self) -> Class

The class of this error.

fn is_fault(&self) -> bool

Whether this error is a fault, rather than the venue answering as designed. False only for defined outcomes, such as a Fill-And-Kill order that matched nothing, or a venue that does not serve the caller’s region. Alerting should key on this; retrying should not.

fn retry_after(&self) -> Option<Duration>

How long the server asked the caller to wait. Defaults to the class’s own; an error whose wait outlives its class, such as a ban that says when it lifts, overrides it. Never Some of zero.

fn is_retriable(&self) -> bool

Whether retrying could plausibly succeed, read from the class (see Class::is_retriable).

impl Clone for NotListed

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NotListed

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

Formats the value using the given formatter.

impl Display for NotListed

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

Formats the value using the given formatter.

impl Eq for NotListed

impl Error for NotListed

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 PartialEq for NotListed

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for NotListed