Struct MarketKey 

pub struct MarketKey { /* private fields */ }

One instrument’s name, written venue.product:id, such as acme.perp:ABCUSD.

A key has no public constructor from text or from parts. Only a product’s KeySpace makes one, and it canonicalizes the id first, so two keys are equal exactly when they name the same instrument. On an event-contract venue a key names one outcome, not a market.

It serializes as its text form. To read one back, parse a RawKey and hand it to the product’s constructors, which canonicalize it again.

use std::borrow::Cow;
use polyoxide_venue::{KeySpace, MarketKey, ProductClass, ProductId, RawKey, VenueId};

/// A perpetual whose ids are ASCII and uppercased.
struct Perp;

impl KeySpace for Perp {
    const VENUE: VenueId = VenueId::from_static("acme");
    const PRODUCT: ProductId = ProductId::from_static("perp");
    const CLASS: ProductClass = ProductClass::PerpetualFuture;
    type Id = PerpId;

    fn parse_id(text: &str) -> Result<PerpId, String> {
        if text.is_ascii() {
            Ok(PerpId(text.to_ascii_uppercase()))
        } else {
            Err("an id is ASCII".into())
        }
    }

    fn id_text(id: &PerpId) -> Cow<'_, str> {
        Cow::Borrowed(&id.0)
    }
}

/// An id in canonical form: only `Perp::parse_id` makes one.
struct PerpId(String);

let key = Perp::parse(&RawKey::parse("acme.perp:abcusd")?)?;
assert_eq!(key, Perp::key(&Perp::parse_id("ABCUSD")?));
assert_eq!(key.to_string(), "acme.perp:ABCUSD");
assert_eq!(key.class(), ProductClass::PerpetualFuture);

Implementations

impl MarketKey

pub fn venue(&self) -> &VenueId

The venue that lists the instrument.

pub fn product(&self) -> &ProductId

The product, the module that trades it.

pub fn class(&self) -> ProductClass

The product’s class, which its KeySpace::CLASS declares. It follows from the venue and product, so the text form does not carry it.

pub fn id(&self) -> &str

The id, in its product’s canonical form. Opaque to everything but its product.

Trait Implementations

impl Clone for MarketKey

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 MarketKey

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

Formats the value using the given formatter.

impl Display for MarketKey

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

Formats the value using the given formatter.

impl Eq for MarketKey

impl Hash for MarketKey

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 MarketKey

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for MarketKey

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for MarketKey

fn partial_cmp(&self, other: &Self) -> 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 MarketKey

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MarketKey