Struct fefix::Dictionary

pub struct Dictionary { /* fields omitted */ }

Specification of the application layer of FIX Protocol.

All FIX Dictionaries have a version string which MUST be unique and established out-of-band between involved parties.

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 with older versions will also contain information about session layer.

Implementations

impl Dictionary

pub fn new<S: ToString>(version: S) -> Self

Creates a new empty FIX Dictionary named version.

Examples

use fefix::Dictionary;
let dict = Dictionary::new("FIX.foobar");

pub fn from_version(version: Version) -> Self

Creates a new Dictionary according to the specification of version.

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;
use fefix::app::Version;

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

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 get_message_by_name<S: AsRef<str>>(&self, name: S) -> Option<Message<'_>>

Returns the [Message] associated with name, if any.

use fefix::Dictionary;
use fefix::app::Version;

let dict = Dictionary::from_version(Version::Fix44);

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

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

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

Returns the [Component] named name, if any.

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

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

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

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

use fefix::Dictionary;
use fefix::app::Version;

let dict = Dictionary::from_version(Version::Fix44);
let msg = dict.messages().find(|m| m.name() == "MarketDataRequest");
assert_eq!(msg.unwrap().msg_type(), "V");

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

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

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

Returns the [Field] associated with tag, if any.

use fefix::Dictionary;
use fefix::app::Version;

let dict = Dictionary::from_version(Version::Fix44);

let field1 = dict.get_field(112).unwrap();
let field2 = dict.get_field_by_name("TestReqID").unwrap();
assert_eq!(field1.name(), field2.name());

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

Returns the [Field] named name, if any.

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

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

Trait Implementations

impl Clone for Dictionary

fn clone(&self) -> Dictionary

Returns a copy of the value.

pub 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.