Struct FinamCidCodec 

pub struct FinamCidCodec;

Codec between the library’s client order id (a UUID) and the fields Finam stores on an order.

Implements [CidCodec]: encode makes the lossless text for the order comment, decode reads it back. FinamCidCodec::client_order_id makes the short, one-way tag for the client_order_id field.

The connector uses it on its own. You need it to read the cid out of an order you fetched through raw(), or to find your order at the broker by its comment.

See the module docs for the reason for two fields.

Implementations

impl FinamCidCodec

pub fn client_order_id(&self, cid: Uuid) -> String

The 20 character tag for the client_order_id field of an order.

20 lowercase hex chars from 10 fully random bytes of the UUID (v4 version/variant skipped). It is one-way: 80 bits of 128 cannot rebuild the cid. It is only a second key for the case when the comment is missing in an echo.

pub fn validate(&self) -> Result<(), Error>

Startup check: the formats must fit the broker limits, otherwise it is a configuration error, not a runtime degradation.

Encodes a sample cid, checks the length of the comment and of the tag, and decodes the comment back. UserDataConnector::start calls it.

Errors

[brokapi_core::Error::Config] when a form does not fit the documented limits (COMMENT_MAX, CLIENT_ORDER_ID_MAX) or does not decode back to the same cid.

Examples

use brokapi_finam::FinamCidCodec;

FinamCidCodec.validate().expect("the codec fits the documented Finam limits");

Trait Implementations

impl CidCodec for FinamCidCodec

fn caps(&self) -> CidCaps

What the broker’s field can hold. Checked by the connector at start.

fn encode(&self, cid: Uuid) -> Result<NativeCid, CidError>

The broker form of cid.

fn decode(&self, native: &NativeCid) -> Option<Uuid>

The cid behind a native string, or None if this codec did not make that string.

impl Clone for FinamCidCodec

fn clone(&self) -> FinamCidCodec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FinamCidCodec

impl Debug for FinamCidCodec

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

Formats the value using the given formatter.

impl Default for FinamCidCodec

fn default() -> FinamCidCodec

Returns the “default value” for a type.