Enum DecodeError 

#[non_exhaustive]
pub enum DecodeError {
    Incomplete,
    InvalidBeginString,
    MissingBodyLength,
    InvalidBodyLength,
    MissingMsgType,
    ChecksumMismatch {
        calculated: u8,
        declared: u8,
    },
    InvalidTag(String),
    MissingRequiredField {
        tag: u32,
    },
    InvalidFieldValue {
        tag: u32,
        reason: String,
    },
    InvalidUtf8(Utf8Error),
    UnterminatedField {
        tag: u32,
    },
    InvalidDataLength {
        data_tag: u32,
        declared: usize,
        available: usize,
    },
    RangeOutOfBounds {
        start: usize,
        end: usize,
        buffer_len: usize,
    },
    InvalidMsgType(MsgTypeError),
}

Errors that occur during FIX message decoding.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Incomplete

Message buffer is incomplete, need more data.

InvalidBeginString

Invalid BeginString field (tag 8).

MissingBodyLength

Missing BodyLength field (tag 9).

InvalidBodyLength

Invalid BodyLength value.

MissingMsgType

Missing MsgType field (tag 35).

ChecksumMismatch

Checksum mismatch between calculated and declared values.

Fields

calculated: u8

Calculated checksum value.

declared: u8

Declared checksum value in message.

InvalidTag(String)

Invalid tag format (not a valid integer).

MissingRequiredField

Missing required field.

Fields

tag: u32

The tag number of the missing field.

InvalidFieldValue

Invalid field value for the expected type.

Fields

tag: u32

The tag number of the field.

reason: String

Description of why the value is invalid.

InvalidUtf8(Utf8Error)

Invalid UTF-8 in string field.

UnterminatedField

A field is not terminated by the SOH delimiter.

Distinct from DecodeError::Incomplete: the tag was well formed, so the bytes are structurally a field, but its value never ends.

Fields

tag: u32

The tag whose value is not terminated.

InvalidDataLength

A Length/Data field pair declares a byte count the frame cannot satisfy.

Raised when the count declared by a LENGTH field (for example RawDataLength, tag 95) runs past what the field may consume, or when the byte at the declared end of the DATA field is not the SOH delimiter.

Fields

data_tag: u32

The tag of the DATA field being framed.

declared: usize

The byte count declared by the paired LENGTH field.

available: usize

Bytes the field was allowed to consume: what remains after the = delimiter, bounded by the frame’s declared body end when decoding a whole message. The terminating SOH must fall inside this.

RangeOutOfBounds

A stored byte range does not lie within the message buffer.

Guards the offset bookkeeping in crate::message::RawMessage, whose ranges are buffer-relative.

Fields

start: usize

Start offset of the offending range.

end: usize

End offset of the offending range.

buffer_len: usize

Length of the buffer the range was applied to.

InvalidMsgType(MsgTypeError)

The MsgType value (tag 35) is not a representable message type.

Raised when the bytes of tag 35 are empty, longer than crate::message::MSG_TYPE_MAX_LEN, or contain a byte that cannot appear in a MsgType. The frame is rejected rather than routed under a truncated or defaulted message type.

Trait Implementations

impl Clone for DecodeError

fn clone(&self) -> DecodeError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DecodeError

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

Formats the value using the given formatter.

impl Display for DecodeError

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

Formats the value using the given formatter.

impl Eq for DecodeError

impl Error for DecodeError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<DecodeError> for FixError

fn from(source: DecodeError) -> Self

Converts to this type from the input type.

impl From<MsgTypeError> for DecodeError

fn from(source: MsgTypeError) -> Self

Converts to this type from the input type.

impl From<Utf8Error> for DecodeError

fn from(source: Utf8Error) -> Self

Converts to this type from the input type.

impl PartialEq for DecodeError

fn eq(&self, other: &DecodeError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for DecodeError