Struct DecoderBuffered

pub struct DecoderBuffered<C = Config> { /* private fields */ }

A (de)serializer for the classic FIX tag-value encoding.

The FIX tag-value encoding is designed to be both human-readable and easy for machines to parse.

Please reach out to the FIX official documentation¹² for more information.

---

1. FIX TagValue Encoding: Online reference. ↩

2. FIX TagValue Encoding: PDF. ↩

Implementations

impl<C> DecoderBuffered<C>

where C: Configure,

pub fn supply_buffer(&mut self) -> &mut [u8]

Provides a buffer that must be filled before re-attempting to deserialize the next Message.

DecoderBuffered::supply_buffer is guaranteed to be non-empty.

Panics

Panics if the last call to DecoderBuffered::parse returned an Err.

pub fn clear(&mut self)

Completes erases the contents of the internal buffer of self.

pub fn parse(&mut self) -> Result<Option<()>, DecodeError>

After filling the buffer provided by DecoderBuffered::supply_buffer, attempt to read its contents. It returns:

• [Ok(None)] in case you need to call DecoderBuffered::supply_buffer again.
• [Ok(Some(()))] in case the internal buffer contains a valid Message, ready to be extracted via DecoderBuffered::message.
• Err on decoding errors.

pub fn message(&self) -> Message<'_, &[u8]>

Panics

Panics if DecoderBuffered::parse() didn’t return [Ok(Some(()))].

Trait Implementations

impl<C: Debug> Debug for DecoderBuffered<C>

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

Formats the value using the given formatter.

impl<C> GetConfig for DecoderBuffered<C>

type Config = C

The configuration options type.

fn config(&self) -> &Self::Config

Returns an immutable reference to the configuration options used by self.

fn config_mut(&mut self) -> &mut Self::Config

Returns a mutable reference to the configuration options used by self.