Skip to main content

Encoder

Struct Encoder 

Source
pub struct Encoder { /* private fields */ }
Expand description

A reusable FIX message encoder.

Owns a body buffer that is allocated once and reused across every encode call — zero allocation per message on the hot path after the first call.

§Example

let mut enc = Encoder::new();
let mut out = Vec::new();
enc.encode(&msg, &mut out)?;

Implementations§

Source§

impl Encoder

Source

pub fn new() -> Self

Create a new encoder with default inline body-buffer capacity.

Source

pub fn with_capacity(capacity: usize) -> Self

Create a new encoder pre-allocated for capacity body bytes.

Source

pub fn disable_auto_calculate_body_length(&mut self, disable: bool) -> &mut Self

When set to true, tag 9 (BodyLength) will not be auto-computed. If the message contains tag 9, its value is written as-is; otherwise the field is omitted entirely.

When false (the default), tag 9 is always computed from the body length.

Source

pub fn disable_auto_calculate_checksum(&mut self, disable: bool) -> &mut Self

When set to true, tag 10 (CheckSum) will not be auto-computed. If the message contains tag 10, its value is written as-is; otherwise the field is omitted entirely.

When false (the default), tag 10 is always computed from the message bytes.

Source

pub fn encode( &mut self, msg: &Message<'_>, out: &mut Vec<u8>, ) -> Result<(), FixError>

Encode msg as a complete FIX wire message into out.

out is cleared first. By default, tag 9 (BodyLength) and tag 10 (CheckSum) are computed automatically and any existing 9 or 10 fields in msg are ignored. Use disable_auto_calculate_body_length(true) or disable_auto_calculate_checksum(true) to write the message’s own values instead. If tag 8 (BeginString) is absent, FIX.4.4 is used as the default version.

Trait Implementations§

Source§

impl Default for Encoder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.