Struct OptionChainResult 

#[non_exhaustive]
pub struct OptionChainResult {
    pub entries: Vec<OptionChainEntry>,
    pub truncation_error: Option<String>,
}

Outcome of an option chain fetch.

Wraps the collected OptionChainEntrys together with whether enumeration was cut short by a mid-stream IB error. An empty entries on its own is ambiguous — a wrong exchange filter also legitimately returns zero rows — so truncation_error disambiguates the confirmed error case, letting callers react programmatically (retry, alert) instead of parsing logs.

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.

entries: Vec<OptionChainEntry>

Entries received before enumeration ended, one per (exchange, trading class) combination.

Each entry is decoded from one complete IB message, so every entry present is valid in isolation even when the enumeration was truncated.

truncation_error: Option<String>

Some(reason) if a mid-stream IB error ended enumeration early — reason is the formatted ibapi::Error — meaning entries may be incomplete. None on a clean end-of-enumeration; an empty entries with None means the underlying genuinely has no listed options for the requested exchange filter, not an error.

The reason is a formatted string rather than a typed error for the same reasons as HistoricalTicks::truncation_error: do not match on the string contents — treat it as human-facing detail and use .is_some() as the programmatic “was this truncated?” check.

Trait Implementations

impl Clone for OptionChainResult

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 OptionChainResult

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

Formats the value using the given formatter.

impl IntoIterator for OptionChainResult

Consumes the wrapper and iterates its entries, discarding truncation_error. Lets callers that only need the data write for chain in chains { .. }, matching the pre-OptionChainResult Vec<OptionChainEntry> ergonomics; inspect the flag before iterating when truncation matters.

type Item = OptionChainEntry

The type of the elements being iterated over.

type IntoIter = IntoIter<OptionChainEntry>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for OptionChainResult

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OptionChainResult