Struct SubscriptionSet 

pub struct SubscriptionSet { /* private fields */ }

The full set of subscriptions the consumer wants: the input of BrokerCore::apply.

It is a plain list in the order given. The set does not check for duplicates: two entries with the same id both stay, and find returns the first.

Examples

use brokapi_core::{InstrumentId, InstrumentKey, NativeId, SubscriptionId};
use brokapi_sansio::{DesiredSubscription, SubscriptionKind, SubscriptionSet};

let sber = InstrumentId::new(
    InstrumentKey::new("SBER", "TQBR"),
    NativeId::TickerClass { ticker: "SBER".into(), class_code: "TQBR".into() },
);
let quotes = DesiredSubscription {
    id: SubscriptionId::new(1),
    kind: SubscriptionKind::Quotes { instrument: sber.clone() },
};
let book = DesiredSubscription {
    id: SubscriptionId::new(2),
    kind: SubscriptionKind::OrderBook { instrument: sber, depth: 10 },
};

let set = SubscriptionSet::with_subscriptions(vec![quotes.clone(), book]);
assert_eq!(set.subs().len(), 2);
assert_eq!(set.find(SubscriptionId::new(1)), Some(&quotes));
assert!(set.find(SubscriptionId::new(9)).is_none());
assert!(SubscriptionSet::new().is_empty());

Implementations

impl SubscriptionSet

pub fn new() -> Self

Creates an empty set: no subscriptions wanted.

pub fn with_subscriptions(subs: Vec<DesiredSubscription>) -> Self

Creates a set from a list, keeping its order.

pub fn subs(&self) -> &[DesiredSubscription]

The subscriptions, in the order given.

pub fn is_empty(&self) -> bool

Whether the set wants nothing.

pub fn iter(&self) -> impl Iterator<Item = &DesiredSubscription>

Iterates over the subscriptions, in the order given.

pub fn find(&self, id: SubscriptionId) -> Option<&DesiredSubscription>

The subscription with this id, or None.

Trait Implementations

impl Clone for SubscriptionSet

fn clone(&self) -> SubscriptionSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubscriptionSet

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

Formats the value using the given formatter.

impl Default for SubscriptionSet

fn default() -> SubscriptionSet

Returns the “default value” for a type.

impl Eq for SubscriptionSet

impl PartialEq for SubscriptionSet

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SubscriptionSet