Enum ByteOrder 

pub enum ByteOrder {
    BigEndian,
    LittleEndian,
    BigEndianSwap,
    LittleEndianSwap,
    BigEndian16,
    LittleEndian16,
}

Unified byte/word order representation for 16/32/64-bit values.

Example

use voltage_modbus::ByteOrder;

let order = ByteOrder::from_str("CDAB").unwrap();
assert_eq!(order, ByteOrder::BigEndianSwap);
assert!(order.has_word_swap());

Variants

BigEndian

Big-endian: ABCD (most significant byte first)

Network byte order, used in most protocols. Example: 0x12345678 → [0x12, 0x34, 0x56, 0x78]

LittleEndian

Little-endian: DCBA (least significant byte first)

Intel x86 native byte order. Example: 0x12345678 → [0x78, 0x56, 0x34, 0x12]

BigEndianSwap

Big-endian with swapped words: CDAB

Common in Modbus and some PLCs. Words are big-endian but swapped. Example: 0x12345678 → [0x56, 0x78, 0x12, 0x34]

LittleEndianSwap

Little-endian with swapped words: BADC

Rare, but exists in some devices. Example: 0x12345678 → [0x34, 0x12, 0x78, 0x56]

BigEndian16

16-bit big-endian: AB

For 16-bit values only. Example: 0x1234 → [0x12, 0x34]

LittleEndian16

16-bit little-endian: BA

For 16-bit values only. Example: 0x1234 → [0x34, 0x12]

Implementations

impl ByteOrder

pub fn from_str(s: &str) -> Option<Self>

Convert from legacy string formats.

Supports various common string representations:

• “ABCD”, “AB-CD” → BigEndian
• “DCBA”, “DC-BA” → LittleEndian
• “CDAB”, “CD-AB” → BigEndianSwap
• “BADC”, “BA-DC” → LittleEndianSwap
• “BE”, “BIG_ENDIAN” → BigEndian
• “LE”, “LITTLE_ENDIAN” → LittleEndian
• “AB” → BigEndian16
• “BA” → LittleEndian16

pub fn as_str(&self) -> &'static str

Get descriptive name.

pub fn is_16bit_only(&self) -> bool

Check if this is a 16-bit only byte order.

pub fn is_big_endian(&self) -> bool

Check if this is a big-endian variant.

pub fn is_little_endian(&self) -> bool

Check if this is a little-endian variant.

pub fn has_word_swap(&self) -> bool

Check if words are swapped (for 32/64-bit values).

Trait Implementations

impl Clone for ByteOrder

fn clone(&self) -> ByteOrder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ByteOrder

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

Formats the value using the given formatter.

impl Default for ByteOrder

fn default() -> Self

Default to big-endian (network byte order).

impl Display for ByteOrder

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

Formats the value using the given formatter.

impl Hash for ByteOrder

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ByteOrder

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ByteOrder

impl Eq for ByteOrder

impl StructuralPartialEq for ByteOrder