Struct BigEndian 

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

A wrapper type that stores a value in big-endian (network) byte order.

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

• Network protocols (which typically use big-endian/“network byte order”)
• File formats that specify big-endian storage
• 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::BigEndian;

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

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

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

In a struct for network protocols

use byteable::{BigEndian, UnsafeByteable};

#[derive(UnsafeByteable, Debug)]
#[repr(C, packed)]
struct TcpHeader {
    source_port: BigEndian<u16>,      // Network byte order
    dest_port: BigEndian<u16>,        // Network byte order
    sequence: BigEndian<u32>,         // Network byte order
}

let header = TcpHeader {
    source_port: 80.into(),
    dest_port: 8080.into(),
    sequence: 12345.into(),
};

Comparison and hashing

use byteable::BigEndian;
use std::collections::HashMap;

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

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

// Can be used as HashMap keys
let mut map = HashMap::new();
map.insert(a, "one hundred");
assert_eq!(map.get(&b), Some(&"one hundred"));

Implementations

impl<T: EndianConvert> BigEndian<T>

pub fn new(value: T) -> Self

Creates a new BigEndian value from a native value.

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

Examples

use byteable::BigEndian;

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

pub fn get(self) -> T

Extracts the native value from this BigEndian wrapper.

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

Examples

use byteable::BigEndian;

let be = BigEndian::new(42u32);
assert_eq!(be.get(), 42);

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

Returns the raw bytes in big-endian order.

This returns the actual byte representation without any conversion.

Examples

use byteable::BigEndian;

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

Trait Implementations

impl<T: EndianConvert> Byteable for BigEndian<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 BigEndian<T>

where T::ByteArray: Clone,

fn clone(&self) -> BigEndian<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 BigEndian<T>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

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

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: Hash + EndianConvert> Hash for BigEndian<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 BigEndian<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 BigEndian<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 BigEndian<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 BigEndian<T>

where T::ByteArray: Copy,

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