Struct SubscriptionId 

pub struct SubscriptionId(pub SmolStr);

New type representing a unique String identifier for a stream that has been subscribed to. This is used to identify data structures received over the socket.

For example, Barter-Data uses this identifier to associate received data structures from the execution with the original Barter-Data Subscription that was actioned over the socket.

Note: Each execution will require the use of different String identifiers depending on the data structures they send.

eg/ SubscriptionId of an FtxTrade is “{BASE}/{QUOTE}” (ie/ market). eg/ SubscriptionId of a BinanceTrade is "@trade|BTCUSDT" (ie/ channel|MARKET).

Tuple Fields

0: SmolStr

Trait Implementations

impl AsRef<str> for SubscriptionId

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<str> for SubscriptionId

Borrow a SubscriptionId as a &str so an instrument map keyed on SubscriptionId can be queried with a borrowed key (e.g. Map::find("@kline_1m|BTCUSDT")) without allocating an owned SubscriptionId per lookup.

Soundness: the Hash, Eq, and Ord impls of SubscriptionId must agree with those of str for Borrow to be valid. SubscriptionId derives all three over its single inner SmolStr field, and SmolStr’s Hash/Eq/Ord delegate to its string contents — so a SubscriptionId hashes, compares, and orders identically to the str it borrows.

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for SubscriptionId

fn clone(&self) -> SubscriptionId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubscriptionId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SubscriptionId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SubscriptionId

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

Formats the value using the given formatter.

impl Eq for SubscriptionId

impl<S> From<S> for SubscriptionId

where S: Into<SmolStr>,

fn from(input: S) -> Self

Converts to this type from the input type.

impl Hash for SubscriptionId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SubscriptionId

fn cmp(&self, other: &SubscriptionId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SubscriptionId

fn eq(&self, other: &SubscriptionId) -> 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 PartialOrd for SubscriptionId

fn partial_cmp(&self, other: &SubscriptionId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for SubscriptionId

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SubscriptionId