Struct LittleEndian 

pub struct LittleEndian<T: EndianConvert>(/* private fields */);

A wrapper type that stores a value in little-endian byte order.

This type ensures that the wrapped value is always stored in little-endian format, regardless of the system’s native endianness. This is particularly useful for:

• File formats that specify little-endian storage (e.g., BMP, WAV, PE executables)
• USB and Bluetooth protocols
• x86/x64 architecture data structures
• Cross-platform binary data interchange

The wrapper is #[repr(transparent)], meaning it has the same memory layout as its inner byte array, making it safe to use in packed structs.

Type Parameters

• T - The underlying numeric type that implements EndianConvert

Examples

Basic usage

use byteable::LittleEndian;

let value = LittleEndian::new(0x12345678u32);

// The bytes are always stored in little-endian order
assert_eq!(value.raw_bytes(), [0x78, 0x56, 0x34, 0x12]);

// Get back the native value
assert_eq!(value.get(), 0x12345678u32);

In a struct for file formats

use byteable::{LittleEndian, UnsafeByteable};

#[derive(UnsafeByteable, Debug)]
#[repr(C, packed)]
struct BmpHeader {
    signature: [u8; 2],               // "BM"
    file_size: LittleEndian<u32>,     // Little-endian
    reserved: u32,
    data_offset: LittleEndian<u32>,   // Little-endian
}

let header = BmpHeader {
    signature: *b"BM",
    file_size: 1024.into(),
    reserved: 0,
    data_offset: 54.into(),
};

Convenient conversions

use byteable::LittleEndian;

// Using From trait
let le: LittleEndian<u16> = 1000.into();
assert_eq!(le.get(), 1000);

// Direct construction
let le = LittleEndian::new(2000u16);
assert_eq!(le.get(), 2000);

Comparison and hashing

use byteable::LittleEndian;
use std::collections::HashSet;

let a = LittleEndian::new(100u32);
let b = LittleEndian::new(100u32);
let c = LittleEndian::new(200u32);

assert_eq!(a, b);
assert!(a < c);

// Can be used in HashSet
let mut set = HashSet::new();
set.insert(a);
assert!(set.contains(&b));

Implementations

impl<T: EndianConvert> LittleEndian<T>

pub fn new(value: T) -> Self

Creates a new LittleEndian value from a native value.

The value is converted to little-endian byte order upon construction.

Examples

use byteable::LittleEndian;

let le = LittleEndian::new(0x1234u16);
assert_eq!(le.raw_bytes(), [0x34, 0x12]);

pub fn get(self) -> T

Extracts the native value from this LittleEndian wrapper.

The bytes are converted from little-endian to the system’s native byte order.

Examples

use byteable::LittleEndian;

let le = LittleEndian::new(42u32);
assert_eq!(le.get(), 42);

pub fn raw_bytes(self) -> T::ByteArray

Returns the raw bytes in little-endian order.

This returns the actual byte representation without any conversion.

Examples

use byteable::LittleEndian;

let le = LittleEndian::new(0x12345678u32);
assert_eq!(le.raw_bytes(), [0x78, 0x56, 0x34, 0x12]);

Trait Implementations

impl<T: EndianConvert> Byteable for LittleEndian<T>

type ByteArray = <T as EndianConvert>::ByteArray

The byte array type used to represent this type.

fn as_byte_array(self) -> Self::ByteArray

Converts this value into a byte array.

fn from_byte_array(byte_array: Self::ByteArray) -> Self

Constructs a value from a byte array.

const BYTE_SIZE: usize = <Self::ByteArray>::BYTE_SIZE

The size of this type in bytes.

impl<T: Clone + EndianConvert> Clone for LittleEndian<T>

where T::ByteArray: Clone,

fn clone(&self) -> LittleEndian<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + EndianConvert> Debug for LittleEndian<T>

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

Formats the value using the given formatter.

impl<T: EndianConvert + Default> Default for LittleEndian<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: EndianConvert> From<T> for LittleEndian<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: Hash + EndianConvert> Hash for LittleEndian<T>

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<T: Ord + EndianConvert> Ord for LittleEndian<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq + EndianConvert> PartialEq for LittleEndian<T>

fn eq(&self, other: &Self) -> 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<T: PartialOrd + EndianConvert> PartialOrd for LittleEndian<T>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Copy + EndianConvert> Copy for LittleEndian<T>

where T::ByteArray: Copy,

impl<T: Eq + EndianConvert> Eq for LittleEndian<T>