Struct fefix::Dictionary

pub struct Dictionary { /* fields omitted */ }

Specifies business semantics for application-level entities within the FIX Protocol.

You can rely on Dictionary for accessing details about fields, messages, and other abstract entities as defined in the FIX specifications. Examples of such information include:

• The mapping of FIX field names to numeric tags (e.g. BeginString is 8).
• Which FIX fields are mandatory and which are optional.
• The data type of each and every FIX field.
• What fields to expect in FIX headers.

N.B. The FIX Protocol mandates separation of concerns between session and application protocol only for FIX 5.0 and subsequent versions. All FIX Dictionaries for older versions will also contain information about the session layer.

Implementations

impl Dictionary

pub fn from_quickfix_spec<S: AsRef<str>>(
    input: S
) -> Result<Self, ParseDictionaryError>

Attempts to read a QuickFIX-style specification file and convert it into a Dictionary.

pub fn empty() -> Self

Creates a new empty FIX Dictionary with FIX.??? as its version string.

pub fn get_version(&self) -> &str

Returns the version string associated with this Dictionary (e.g. FIXT.1.1, FIX.4.2).

use fefix::Dictionary;

let dict = Dictionary::fix44();
assert_eq!(dict.get_version(), "FIX.4.4");

pub fn fix40() -> Self

This is supported on crate feature fix40 only.

Creates a new Dictionary for FIX 4.0.

pub fn fix41() -> Self

This is supported on crate feature fix41 only.

Creates a new Dictionary for FIX 4.1.

pub fn fix42() -> Self

This is supported on crate feature fix42 only.

Creates a new Dictionary for FIX 4.2.

pub fn fix43() -> Self

This is supported on crate feature fix43 only.

Creates a new Dictionary for FIX 4.3.

pub fn fix44() -> Self

Creates a new Dictionary for FIX 4.4.

pub fn fix50() -> Self

This is supported on crate feature fix50 only.

Creates a new Dictionary for FIX 5.0.

pub fn fix50sp1() -> Self

This is supported on crate feature fix50sp1 only.

Creates a new Dictionary for FIX 5.0 SP1.

pub fn fix50sp2() -> Self

This is supported on crate feature fix50sp1 only.

Creates a new Dictionary for FIX 5.0 SP2.

pub fn fixt11() -> Self

This is supported on crate feature fixt11 only.

Creates a new Dictionary for FIXT 1.1.

pub fn abbreviation_for<S: AsRef<str>>(
    &self,
    term: S
) -> Option<Abbreviation<'_>>

Return the known abbreviation for term -if any- according to the documentation of this FIX Dictionary.

pub fn message_by_name<S: AsRef<str>>(&self, name: S) -> Option<Message<'_>>

Returns the Message associated with name, if any.

use fefix::Dictionary;

let dict = Dictionary::fix44();

let msg1 = dict.message_by_name("Heartbeat").unwrap();
let msg2 = dict.message_by_msgtype("0").unwrap();
assert_eq!(msg1.name(), msg2.name());

pub fn message_by_msgtype<S: AsRef<str>>(
    &self,
    msgtype: S
) -> Option<Message<'_>>

Returns the Message that has the given msgtype, if any.

use fefix::Dictionary;

let dict = Dictionary::fix44();

let msg1 = dict.message_by_msgtype("0").unwrap();
let msg2 = dict.message_by_name("Heartbeat").unwrap();
assert_eq!(msg1.name(), msg2.name());

pub fn component_by_name<S: AsRef<str>>(&self, name: S) -> Option<Component<'_>>

Returns the Component named name, if any.

pub fn datatype_by_name<S: AsRef<str>>(&self, name: S) -> Option<Datatype<'_>>

Returns the Datatype named name, if any.

use fefix::Dictionary;

let dict = Dictionary::fix44();
let dt = dict.datatype_by_name("String").unwrap();
assert_eq!(dt.name(), "String");

pub fn field_by_tag(&self, tag: u32) -> Option<Field<'_>>

Returns the Field associated with tag, if any.

use fefix::Dictionary;

let dict = Dictionary::fix44();
let field1 = dict.field_by_tag(112).unwrap();
let field2 = dict.field_by_name("TestReqID").unwrap();
assert_eq!(field1.name(), field2.name());

pub fn field_by_name<S: AsRef<str>>(&self, name: S) -> Option<Field<'_>>

Returns the Field named name, if any.

pub fn iter_datatypes(&self) -> impl Iterator<Item = Datatype<'_>>

Returns an Iterator over all Datatype defined in self. Items are in no particular order.

use fefix::Dictionary;

let dict = Dictionary::fix44();
// FIX 4.4 defines 23 (FIXME) datatypes.
assert_eq!(dict.iter_datatypes().count(), 23);

pub fn iter_messages(&self) -> impl Iterator<Item = Message<'_>>

Returns an Iterator over this Dictionary’s messages. Items are in no particular order.

use fefix::Dictionary;

let dict = Dictionary::fix44();
let msg = dict.iter_messages().find(|m| m.name() == "MarketDataRequest");
assert_eq!(msg.unwrap().msg_type(), "V");

pub fn iter_categories(&self) -> impl Iterator<Item = Category<'_>>

Returns an Iterator over this Dictionary’s categories. Items are in no particular order.

pub fn iter_fields(&self) -> impl Iterator<Item = Field<'_>>

Returns an Iterator over this Dictionary’s fields. Items are in no particular order.

pub fn iter_components(&self) -> impl Iterator<Item = Component<'_>>

Returns an Iterator over this Dictionary’s components. Items are in no particular order.

Trait Implementations

impl Clone for Dictionary

fn clone(&self) -> Dictionary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dictionary

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

Formats the value using the given formatter.

impl Display for Dictionary

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

Formats the value using the given formatter.