Struct ClientOrderIdEncoder 

pub struct ClientOrderIdEncoder { /* private fields */ }

Manages bidirectional mapping of ClientOrderId ↔ (client_id, client_metadata) for dYdX.

Encoding Strategy

1. Numeric IDs (e.g., “12345”): Encoded as (12345, 4) for backward compatibility
2. O-format IDs (e.g., “O-20260131-174827-001-001-1”): Deterministically encoded
3. Other formats: Sequential allocation with in-memory mapping

Thread Safety

All operations are thread-safe using DashMap and AtomicU32.

Implementations

impl ClientOrderIdEncoder

pub fn new() -> Self

Creates a new encoder with counter starting at 1.

pub fn encode( &self, id: ClientOrderId, ) -> Result<EncodedClientOrderId, EncoderError>

Encodes a ClientOrderId to (client_id, client_metadata) pair.

Encoding Rules

1. If already mapped in cache, returns existing encoded pair
2. If numeric (e.g., “12345”), returns (12345, DEFAULT_RUST_CLIENT_METADATA)
3. If O-format, deterministically encodes timestamp + identity bits
4. Otherwise, allocates sequential ID for fallback

Errors

Returns EncoderError::CounterOverflow if sequential counter exceeds safe limit. Returns EncoderError::ValueOverflow if O-format values exceed bit limits.

pub fn decode( &self, client_id: u32, client_metadata: u32, ) -> Option<ClientOrderId>

Decodes (client_id, client_metadata) back to the original ClientOrderId.

Decoding Rules

1. If client_metadata == DEFAULT_RUST_CLIENT_METADATA (4): Return numeric string
2. If client_metadata == SEQUENTIAL_METADATA_MARKER: Look up in sequential reverse mapping
3. Otherwise: Decode as O-format using timestamp + identity bits

Returns None if decoding fails (e.g., sequential ID not in cache).

pub fn get(&self, id: &ClientOrderId) -> Option<EncodedClientOrderId>

Gets the existing encoded pair without allocating a new one.

First checks the forward mapping (for updated/modified orders), then falls back to deterministic computation for O-format and numeric IDs.

pub fn remove( &self, client_id: u32, client_metadata: u32, ) -> Option<ClientOrderId>

Removes the mapping for a given encoded pair.

Returns the original ClientOrderId if it was mapped. For deterministic formats, this is a no-op.

pub fn remove_by_client_id(&self, client_id: u32) -> Option<ClientOrderId>

Legacy remove method for backward compatibility. Removes by client_id only, assumes DEFAULT_RUST_CLIENT_METADATA.

pub fn current_counter(&self) -> u32

Returns the current counter value (for debugging/monitoring).

pub fn len(&self) -> usize

Returns the number of non-deterministic mappings currently stored.

pub fn is_empty(&self) -> bool

Returns true if no non-deterministic mappings are stored.

Trait Implementations

impl Debug for ClientOrderIdEncoder

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

Formats the value using the given formatter.

impl Default for ClientOrderIdEncoder

fn default() -> Self

Returns the “default value” for a type.