Enum Endian 

pub enum Endian {
    Big,
    Little,
}

An Enum for handling byte order.

Variants

Big

Little

Implementations

impl Endian

pub const NATIVE: Self = NATIVE_ENDIAN

The byte order of the current target.

Examples

use lib_endian::Endian;
const NE: Endian = Endian::NATIVE;

pub const fn is(self, other: Self) -> bool

Tests for self and other values to be equal.

Examples

use lib_endian::Endian;
const BE: Endian = Endian::Big;
const IS_EQUAL: bool = BE.is(Endian::Big);
assert!(IS_EQUAL);

You can also use == out Constant Expressions:

use lib_endian::Endian;
let be = Endian::Big;
let is_equal = be == Endian::Big;
assert!(is_equal);

pub const fn reverse(self) -> Self

Returns a new Endian value which is different from self.

Examples

use lib_endian::Endian;
const BE: Endian = Endian::Little.reverse();
const IS_EQUAL: bool = BE.reverse().is(Endian::Little);
assert!(IS_EQUAL);

You can also use ! out Constant Expressions:

use lib_endian::Endian;
let be = !Endian::Little;
let is_equal = !be == Endian::Little;
assert!(is_equal);

pub const fn native_or_reversed(reverse: bool) -> Self

Returns Endian::native() if reverse is true,
otherwise returns Endian::native().reverse().

Examples

use lib_endian::Endian;

const REVERSE: bool = true;

const NE_REV: Endian = Endian::native_or_reversed(REVERSE);
assert_eq!(NE_REV, Endian::NATIVE.reverse());

const NE: Endian = Endian::native_or_reversed(!REVERSE);
assert_eq!(NE, Endian::NATIVE);

Trait Implementations

impl Clone for Endian

fn clone(&self) -> Endian

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Endian

impl Debug for Endian

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

Formats the value using the given formatter.

impl Eq for Endian

impl Hash for Endian

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 Not for Endian

type Output = Endian

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq for Endian

fn eq(&self, other: &Endian) -> 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 StructuralPartialEq for Endian