Enum NoticeCategory 

#[non_exhaustive]
pub enum NoticeCategory {
    Cancellation,
    Warning,
    SystemMessage,
    OrderRejection,
    RequestError,
    DataAdvisory,
    Error,
}

Typed classification of a Notice by TWS error-code range.

Returned by Notice::category. Forms a disjoint partition over all possible notices; when classifications overlap on the wire, the classifier resolves overlap by precedence:

1. Cancellation — exact code 202.
2. DataAdvisory — DATA_ADVISORY_CODES. Ahead of the ranges: 317 is inside ORDER_REJECTION_CODE_RANGE and 2188 inside WARNING_CODE_RANGE.
3. Warning — WARNING_CODE_RANGE, code 399 with a Warning: line, or code 0 (a frame whose error_code field was absent on the wire).
4. SystemMessage — 1100, 1101, 1102, 1300.
5. RequestError — REQUEST_ERROR_CODES. Ahead of ORDER_REJECTION_CODE_RANGE, which they sit inside.
6. OrderRejection — ORDER_REJECTION_CODE_RANGE, excluding the cases above.
7. Error — everything else.

Each Notice::is_* category predicate (Notice::is_cancellation, Notice::is_warning, …) is category() == X for its variant X, so the predicates are disjoint too.

Marked #[non_exhaustive] so IBKR can introduce new code ranges without a breaking release.

Examples

use ibapi::{Notice, NoticeCategory};
match notice.category() {
    NoticeCategory::OrderRejection => eprintln!("rejected: {}", notice),
    NoticeCategory::RequestError   => eprintln!("failed: {}",   notice),
    NoticeCategory::Warning        => eprintln!("warn: {}",     notice),
    NoticeCategory::Error          => eprintln!("error: {}",    notice),
    _ => {}
}

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.

Cancellation

Order cancellation confirmation (exact code 202).

Warning

Informational warning (WARNING_CODE_RANGE, code 399 with a Warning: line, or code 0 — a code-less frame).

SystemMessage

Connectivity / system status (codes 1100, 1101, 1102, 1300).

OrderRejection

Order rejection (ORDER_REJECTION_CODE_RANGE, excluding the cases above it in the precedence chain).

RequestError

A request other than an order failed (REQUEST_ERROR_CODES): market data, depth, historical data, scanner, session setup. Terminal.

DataAdvisory

Data advisory (DATA_ADVISORY_CODES): the request is not rejected and data follows — a fallback, a partial entitlement, or a depth-book reset. Informational.

Error

Any other error code.

Trait Implementations

impl Clone for NoticeCategory

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for NoticeCategory

impl Debug for NoticeCategory

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

Formats the value using the given formatter.

impl Eq for NoticeCategory

impl PartialEq for NoticeCategory

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for NoticeCategory