endbyte

a no_std compatible rust library for handling byte order conversions between different endianness formats.

features

• no_std compatible: works in embedded environments without the standard library
• zero dependencies: no external crates required
• comprehensive type support: supports all standard integer types (u8, u16, u32, u64, u128, i8, i16, i32, i64, i128)
• efficient: uses rust's built-in swap_bytes() methods for optimal performance
• compile-time endianness detection: zero runtime overhead for endianness checks
• well tested: comprehensive test suite including embedded target testing

usage

add this to your Cargo.toml:

[dependencies]
endbyte = "0.1.0"

basic usage

use endbyte::Endianness;

let value = 0x1234u16;

// convert to specific endianness
let big_endian = value.host_to_big_endian();
let little_endian = value.host_to_little_endian();

// convert from specific endianness back to host
let from_big = big_endian.big_endian_to_host();
let from_little = little_endian.little_endian_to_host();

assert_eq!(from_big, value);
assert_eq!(from_little, value);

embedded usage

this library is designed to work in no_std environments:

#![no_std]

use endbyte::Endianness;

fn process_network_data(data: u32) -> u32 {
    // convert from network byte order (big endian) to host
    let host_value = data.big_endian_to_host();

    // process the value...
    let result = host_value * 2;

    // convert back to network byte order
    result.host_to_big_endian()
}

supported types

the Endianness trait is implemented for all standard integer types:

• unsigned: u8, u16, u32, u64, u128
• signed: i8, i16, i32, i64, i128

note: single-byte types (u8, i8) have zero-cost implementations since byte swapping is not needed.

methods

• host_to_big_endian(): convert from host byte order to big endian
• host_to_little_endian(): convert from host byte order to little endian
• big_endian_to_host(): convert from big endian to host byte order
• little_endian_to_host(): convert from little endian to host byte order

performance

this library is designed for maximum performance:

• uses rust's built-in swap_bytes() methods which compile to optimal assembly
• compile-time endianness detection means zero runtime overhead
• single-byte types have zero-cost implementations
• all methods are marked #[inline] for optimal inlining

testing

the library includes comprehensive tests that work on both big and little endian systems:

cargo test

for embedded targets:

cargo build --target thumbv7em-none-eabihf
cargo build --target thumbv6m-none-eabi

license

this project is licensed under the mit license - see the license file for details.