Enum ProtocolError 

#[non_exhaustive]
pub enum ProtocolError {
    IncompletePacket {
        expected: usize,
        actual: usize,
    },
    InvalidPacketType(u8),
    InvalidTokenType(u8),
    InvalidDataType(u8),
    InvalidPreloginOption(u8),
    InvalidTdsVersion(u32),
    StringEncoding(String),
    PacketTooLarge {
        length: usize,
        max: usize,
    },
    InvalidPacketStatus(u8),
    BufferOverflow {
        needed: usize,
        capacity: usize,
    },
    UnexpectedEof,
    UnsupportedVersion(u32),
    InvalidField {
        field: &'static str,
        value: u32,
    },
}

Errors that can occur during TDS protocol parsing or encoding.

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.

IncompletePacket

Packet data is truncated or incomplete.

Fields

expected: usize

Expected number of bytes.

actual: usize

Actual number of bytes available.

InvalidPacketType(u8)

Invalid packet type value.

InvalidTokenType(u8)

Invalid token type value.

InvalidDataType(u8)

Invalid data type value.

InvalidPreloginOption(u8)

Invalid prelogin option.

InvalidTdsVersion(u32)

Invalid TDS version.

StringEncoding(String)

String encoding error.

PacketTooLarge

Packet length exceeds maximum allowed.

Fields

length: usize

Actual packet length.

max: usize

Maximum allowed length.

InvalidPacketStatus(u8)

Invalid packet status flags.

BufferOverflow

Buffer overflow during encoding.

Fields

needed: usize

Bytes needed.

capacity: usize

Buffer capacity.

UnexpectedEof

Unexpected end of stream.

UnsupportedVersion(u32)

Protocol version mismatch.

InvalidField

Invalid field value in a protocol structure.

Fields

field: &'static str

Field name.

value: u32

Invalid value.

Implementations

impl ProtocolError

pub fn is_transient(&self) -> bool

Check if this error is transient and may succeed on retry.

Protocol errors are almost always terminal — they indicate malformed data or driver bugs. The only transient case is UnexpectedEof, which may occur during connection loss.

pub fn is_terminal(&self) -> bool

Check if this error is terminal and will never succeed on retry.

Most protocol errors indicate a fundamental mismatch between client and server, a driver bug, or corrupted data.

Trait Implementations

impl Debug for ProtocolError

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

Formats the value using the given formatter.

impl Display for ProtocolError

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

Formats the value using the given formatter.

impl Error for ProtocolError

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.