Expand description
Subscription types for streaming data Subscription types for sync/async streaming data.
§Canonical paths
- Async
Subscription/ extensions —ibapi::Subscription,ibapi::subscriptions::SubscriptionItemStreamExt. The crate-root andsubscriptions::*re-exports resolve to the async implementation whenever theasyncfeature is on (which is the default). - Blocking (sync)
Subscription/ iterators —ibapi::client::blocking::Subscription(andSubscriptionIter,SubscriptionOwnedIter, etc.). The labelledblockingsubmodule is the canonical sync-explicit path. When onlysyncis enabled,ibapi::Subscriptionalso resolves to the blocking form.
The subscriptions::sync and subscriptions::r#async submodules where
the impls live are #[doc(hidden)]: still reachable as paths for
crate-internal use, but intentionally absent from the docs.rs navigation.
Prefer the canonical spellings above. Raw-identifier syntax
(subscriptions::r#async::Subscription) is the giveaway that the spelling
is non-canonical.
Structs§
- Filter
Data - Adapter that filters
SubscriptionItem::Noticeitems (logging them atwarn!) from anyIterator<Item = Result<SubscriptionItem<T>, Error>>and yields the underlyingResult<T, Error>to the caller. - Filter
Data Stream - Stream adapter that filters
SubscriptionItem::Noticeitems (logging them atwarn!) from anyStream<Item = Result<SubscriptionItem<T>, Error>>and yields the underlyingResult<T, Error>to the caller. - Notice
Stream - A handle for receiving globally routed notices on the async transport.
- Notice
Stream Iter - Blocking iterator yielded by
NoticeStream::iter. - Subscription
- Asynchronous subscription for streaming data.
- Subscription
Iter - Blocking iterator over
Result<SubscriptionItem<T>, Error>. - Subscription
Owned Iter - Owned blocking iterator over
Result<SubscriptionItem<T>, Error>. - Subscription
Timeout Iter - Timeout-bounded iterator.
- Subscription
TryIter - Non-blocking iterator.
Enums§
- Subscription
Item - An item yielded by a
Subscription.
Traits§
- Shares
Channel - Marker trait for subscriptions that share a channel based on message type
- Subscription
Item Iter Ext - Extension trait that adds
filter_datato any iterator yieldingResult<SubscriptionItem<T>, Error>. Use it to compose the data-only flow with iterator combinators that the built-initer_datafamily doesn’t already cover, e.g.subscription.iter().take(10).filter_data(). - Subscription
Item Stream Ext - Extension trait that adds
filter_datato any stream yieldingResult<SubscriptionItem<T>, Error>. Async mirror of the syncSubscriptionItemIterExt.