Struct OrderIndex 

pub struct OrderIndex { /* private fields */ }

Memory of which Finam order id belongs to which client order id.

Thread safe. The user data connector owns one and its core reads it for every order echo.

See the module docs for an example.

Implementations

impl OrderIndex

pub fn new() -> Self

An empty index.

pub fn know(&self, cid: ClientOrderId)

A cid this process knows about: its tag becomes a lookup key for echoes without comment.

pub fn bind(&self, cid: ClientOrderId, order_id: &str)

Remembers that Finam order order_id belongs to cid. An empty order_id is ignored.

pub fn forget(&self, cid: ClientOrderId)

Forgets everything kept for cid: the pair with its Finam order id and its tag. For an order that finished long ago. A later echo of that order resolves through its comment again, or to a made-up cid.

pub fn order_id(&self, cid: ClientOrderId) -> Option<String>

Finam order id of cid, if this process has seen the pair. None does not mean the order does not exist: after a restart call reconcile first.

pub fn lookup(&self, order_id: &str, comment: &str) -> Option<ClientOrderId>

Like OrderIndex::resolve but never invents a cid: None for orders that are not ours.

pub fn resolve( &self, order_id: &str, client_order_id: &str, comment: &str, ) -> ClientOrderId

Cid of an order echo, in order of trust: comment, known order id, known tag, otherwise a stable made-up cid (UUID v5 of the order id). The result is bound to order_id.

Trait Implementations

impl Debug for OrderIndex

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

Formats the value using the given formatter.

impl Default for OrderIndex

fn default() -> OrderIndex

Returns the “default value” for a type.