Enum byteordered::Endianness

pub enum Endianness {
    Little,
    Big,
}

Enumerate for materializing the two kinds of machine byte order supported by Rust.

Variants

Little

Little Endian

Big

Big Endian

Methods

impl Endianness

pub fn native() -> Self

Obtains this system's native endianness.

On this platform, the function returns Endianness::Little.

pub fn le_iff(e: bool) -> Self

Obtains Little Endian if and only if the given value is true.

Examples

let data: &[u8] = &[4, 1];
let e = Endianness::le_iff(2 + 2 == 4);
assert_eq!(e.read_u16(data).unwrap(), 260);

let e = Endianness::le_iff(2 + 2 >= 5);
assert_eq!(e.read_u16(data).unwrap(), 1025);

pub fn be_iff(e: bool) -> Self

Obtains Big Endian if and only if the given value is true.

Examples

assert_eq!(Endianness::be_iff(2 + 2 == 4), Endianness::Big);
assert_eq!(Endianness::be_iff(2 + 2 >= 5), Endianness::Little);

pub fn to_opposite(self) -> Self

Obtains the opposite endianness: Little Endian returns Big Endian and vice versa.

Trait Implementations

impl Endian for Endianness

type Opposite = Self

A type which can represent a byte order that is opposite to this one.

fn into_opposite(self) -> Self::Opposite

Converts the receiver into its opposite.

fn is_native(&self) -> bool

Checks whether this value represents the system's native endianness.

fn read_i16<S>(&self, src: S) -> IoResult<i16> where
    S: Read, 

Reads a signed 16 bit integer from the given reader.

fn read_u16<S>(&self, src: S) -> IoResult<u16> where
    S: Read, 

Reads an unsigned 16 bit integer from the given reader.

fn read_i32<S>(&self, src: S) -> IoResult<i32> where
    S: Read, 

Reads a signed 32 bit integer from the given reader.

fn read_u32<S>(&self, src: S) -> IoResult<u32> where
    S: Read, 

Reads an unsigned 32 bit integer from the given reader.

fn read_i64<S>(&self, src: S) -> IoResult<i64> where
    S: Read, 

Reads a signed 64 bit integer from the given reader.

fn read_u64<S>(&self, src: S) -> IoResult<u64> where
    S: Read, 

Reads an unsigned 16 bit integer from the given reader.

fn read_f32<S>(&self, src: S) -> IoResult<f32> where
    S: Read, 

Reads a IEEE754 single-precision (4 bytes) floating point number from the given reader.

fn read_f64<S>(&self, src: S) -> IoResult<f64> where
    S: Read, 

Reads a IEEE754 double-precision (8 bytes) floating point number from the given reader.

fn read_i128<S>(&self, src: S) -> IoResult<i128> where
    S: Read, 

Reads a signed 128 bit integer from the given reader.

fn read_u128<S>(&self, src: S) -> IoResult<u128> where
    S: Read, 

Reads an unsigned 16 bit integer from the given reader.

fn write_i16<S>(&self, src: S, v: i16) -> IoResult<()> where
    S: Write, 

Writes a signed 16 bit integer to the given writer.

fn write_u16<S>(&self, src: S, v: u16) -> IoResult<()> where
    S: Write, 

Writes an unsigned 16 bit integer to the given writer.

fn write_i32<S>(&self, src: S, v: i32) -> IoResult<()> where
    S: Write, 

Writes a signed 32 bit integer to the given writer.

fn write_u32<S>(&self, src: S, v: u32) -> IoResult<()> where
    S: Write, 

Writes an unsigned 32 bit integer to the given writer.

fn write_i64<S>(&self, src: S, v: i64) -> IoResult<()> where
    S: Write, 

Writes a signed 64 bit integer to the given writer.

fn write_u64<S>(&self, src: S, v: u64) -> IoResult<()> where
    S: Write, 

Writes an unsigned 64 bit integer to the given writer.

fn write_f32<S>(&self, src: S, v: f32) -> IoResult<()> where
    S: Write, 

Writes a IEEE754 single-precision (4 bytes) floating point number to the given writer.

fn write_f64<S>(&self, src: S, v: f64) -> IoResult<()> where
    S: Write, 

Writes a IEEE754 double-precision (8 bytes) floating point number to the given writer.

fn write_i128<S>(&self, src: S, v: i128) -> IoResult<()> where
    S: Write, 

Writes a signed 128 bit integer to the given writer.

fn write_u128<S>(&self, src: S, v: u128) -> IoResult<()> where
    S: Write, 

Writes an unsigned 128 bit integer to the given writer.

impl From<StaticEndianness<LittleEndian>> for Endianness

fn from(_: StaticEndianness<LittleEndian>) -> Self

Performs the conversion.

impl From<StaticEndianness<BigEndian>> for Endianness

fn from(_: StaticEndianness<BigEndian>) -> Self

Performs the conversion.

impl Clone for Endianness

fn clone(&self) -> Endianness

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Endianness

impl Eq for Endianness

impl Ord for Endianness

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Endianness> for StaticEndianness<BigEndian>

fn eq(&self, e: &Endianness) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Endianness> for StaticEndianness<LittleEndian>

fn eq(&self, e: &Endianness) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Endianness> for Endianness

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<StaticEndianness<BigEndian>> for Endianness

fn eq(&self, _: &StaticEndianness<BigEndian>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<StaticEndianness<LittleEndian>> for Endianness

fn eq(&self, _: &StaticEndianness<LittleEndian>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Endianness> for Endianness

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

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

impl Debug for Endianness

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

Formats the value using the given formatter.

impl Hash for Endianness

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, 

Feeds a slice of this type into the given [Hasher].

impl StructuralPartialEq for Endianness

impl StructuralEq for Endianness