Enum VenueOrderId 

pub enum VenueOrderId {
    Assigned(OrderId),
    ClientAssigned,
}

How an order accepted by a venue can be addressed.

A venue normally answers an accepted order with an identifier of its own, and that identifier is what every later message about the order carries. Some venues do not: they acknowledge the order while assigning nothing, and it remains addressable only by the ClientOrderId the caller sent. Hyperliquid does this for an order that is resting but not yet triggered, where the cancel endpoint takes the client id.

Naming both cases keeps them apart. The alternative – storing the client id in the same field as a venue id – makes the field a union of two identifier kinds that can only be told apart by inspecting the string, and leaves a consumer unable to answer the one question that matters: whether two states describe the same venue order. See Self::assigned.

Variants

Assigned(OrderId)

The venue assigned its own identifier, and this is it.

ClientAssigned

The venue accepted the order without assigning an identifier. It is addressable only by the ClientOrderId that was sent with it.

Implementations

impl VenueOrderId

pub fn assigned(&self) -> Option<&OrderId>

The venue’s own identifier, or None if it never assigned one.

Use this rather than matching on the variant when the question is identity: two states describe the same venue order only when both are Some and equal. Two Nones prove nothing – neither carries an identifier to compare – so None == None must not be read as a match.

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

Whether this is the same venue order as other, as far as either can tell.

false unless both carry a venue identifier and the two agree. A state with no venue identifier cannot be shown to be the same order as anything, including another such state.

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

Whether the venue has assigned an identifier that differs from other’s.

This is the safe negation of Self::is_same_order_as: it is true only on positive evidence of a different order, never on the mere absence of an identifier. A caller rejecting an update must test this rather than !is_same_order_as(..), which is also true when nothing is known.

pub fn or_client_id(&self, cid: &ClientOrderId) -> OrderId

The identifier a terminal state records for this order.

Cancelled, Filled and Expired carry a plain OrderId: they are records of an order that has ended, not handles for addressing one, and nothing compares them for identity. An order the venue never named has no identifier of its own to record, so it records cid – the client id it was addressed by throughout its life.

Trait Implementations

impl Clone for VenueOrderId

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 VenueOrderId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VenueOrderId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for VenueOrderId

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

Formats the value using the given formatter.

impl Eq for VenueOrderId

impl From<OrderId> for VenueOrderId

fn from(id: OrderId) -> Self

Converts to this type from the input type.

impl Hash for VenueOrderId

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 VenueOrderId

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 VenueOrderId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for VenueOrderId

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 VenueOrderId

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 VenueOrderId