Struct BE

pub struct BE<T>(pub T);

Big Endian (BE) wrapper type This type is used to indicate that the value is in big endian format It’s primary use is in deriving from BinaryIo trait

Example

use binary_util::types::BE;
use binary_util::BinaryIo;

#[derive(BinaryIo)]
struct MyStruct {
  test: BE<u32>,
}

Tuple Fields

0: T

Implementations

impl<T> BE<T>

pub fn new(val: T) -> Self

Methods from Deref<Target = u16>

pub const MIN: u16 = 0u16

pub const MAX: u16 = 65_535u16

pub const BITS: u32 = 16u32

Trait Implementations

impl<T: Clone> Clone for BE<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for BE<T>

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

Formats the value using the given formatter.

impl Deref for BE<f32>

type Target = f32

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Deref for BE<f64>

type Target = f64

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Deref for BE<i128>

type Target = i128

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Deref for BE<i16>

type Target = i16

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Deref for BE<i24>

type Target = i24

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Deref for BE<i32>

type Target = i32

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Deref for BE<i64>

type Target = i64

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Deref for BE<u128>

type Target = u128

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Deref for BE<u16>

type Target = u16

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Deref for BE<u24>

type Target = u24

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Deref for BE<u32>

type Target = u32

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Deref for BE<u64>

type Target = u64

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for BE<f32>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl DerefMut for BE<f64>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl DerefMut for BE<i128>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl DerefMut for BE<i16>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl DerefMut for BE<i24>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl DerefMut for BE<i32>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl DerefMut for BE<i64>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl DerefMut for BE<u128>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl DerefMut for BE<u16>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl DerefMut for BE<u24>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl DerefMut for BE<u32>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl DerefMut for BE<u64>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<BE<f32>> for f32

fn from(val: BE<f32>) -> Self

Converts to this type from the input type.

impl From<BE<f64>> for f64

fn from(val: BE<f64>) -> Self

Converts to this type from the input type.

impl From<BE<i128>> for i128

fn from(val: BE<i128>) -> Self

Converts to this type from the input type.

impl From<BE<i16>> for i16

fn from(val: BE<i16>) -> Self

Converts to this type from the input type.

impl From<BE<i24>> for i24

fn from(val: BE<i24>) -> Self

Converts to this type from the input type.

impl From<BE<i32>> for i32

fn from(val: BE<i32>) -> Self

Converts to this type from the input type.

impl From<BE<i64>> for i64

fn from(val: BE<i64>) -> Self

Converts to this type from the input type.

impl From<BE<u128>> for u128

fn from(val: BE<u128>) -> Self

Converts to this type from the input type.

impl From<BE<u16>> for u16

fn from(val: BE<u16>) -> Self

Converts to this type from the input type.

impl From<BE<u24>> for u24

fn from(val: BE<u24>) -> Self

Converts to this type from the input type.

impl From<BE<u32>> for u32

fn from(val: BE<u32>) -> Self

Converts to this type from the input type.

impl From<BE<u64>> for u64

fn from(val: BE<u64>) -> Self

Converts to this type from the input type.

impl From<f32> for BE<f32>

fn from(val: f32) -> Self

Converts to this type from the input type.

impl From<f64> for BE<f64>

fn from(val: f64) -> Self

Converts to this type from the input type.

impl From<i128> for BE<i128>

fn from(val: i128) -> Self

Converts to this type from the input type.

impl From<i16> for BE<i16>

fn from(val: i16) -> Self

Converts to this type from the input type.

impl From<i24> for BE<i24>

fn from(val: i24) -> Self

Converts to this type from the input type.

impl From<i32> for BE<i32>

fn from(val: i32) -> Self

Converts to this type from the input type.

impl From<i64> for BE<i64>

fn from(val: i64) -> Self

Converts to this type from the input type.

impl From<u128> for BE<u128>

fn from(val: u128) -> Self

Converts to this type from the input type.

impl From<u16> for BE<u16>

fn from(val: u16) -> Self

Converts to this type from the input type.

impl From<u24> for BE<u24>

fn from(val: u24) -> Self

Converts to this type from the input type.

impl From<u32> for BE<u32>

fn from(val: u32) -> Self

Converts to this type from the input type.

impl From<u64> for BE<u64>

fn from(val: u64) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for BE<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> Ord for BE<T>

fn cmp(&self, other: &BE<T>) -> 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> PartialEq for BE<T>

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

fn partial_cmp(&self, other: &BE<T>) -> 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 Reader<BE<f32>> for BE<f32>

fn read(buf: &mut ByteReader) -> Result<BE<f32>, Error>

Reads Self from a ByteReader.

fn read_from_slice(buf: &[u8]) -> Result<Output, Error>

Reads Self from a &[u8].

impl Reader<BE<f64>> for BE<f64>

fn read(buf: &mut ByteReader) -> Result<BE<f64>, Error>

Reads Self from a ByteReader.

fn read_from_slice(buf: &[u8]) -> Result<Output, Error>

Reads Self from a &[u8].

impl Reader<BE<i128>> for BE<i128>

fn read(buf: &mut ByteReader) -> Result<BE<i128>, Error>

Reads Self from a ByteReader.

fn read_from_slice(buf: &[u8]) -> Result<Output, Error>

Reads Self from a &[u8].

impl Reader<BE<i16>> for BE<i16>

fn read(buf: &mut ByteReader) -> Result<BE<i16>, Error>

Reads Self from a ByteReader.

fn read_from_slice(buf: &[u8]) -> Result<Output, Error>

Reads Self from a &[u8].

impl Reader<BE<i24>> for BE<i24>

fn read(buf: &mut ByteReader) -> Result<BE<i24>, Error>

Reads Self from a ByteReader.

fn read_from_slice(buf: &[u8]) -> Result<Output, Error>

Reads Self from a &[u8].

impl Reader<BE<i32>> for BE<i32>

fn read(buf: &mut ByteReader) -> Result<BE<i32>, Error>

Reads Self from a ByteReader.

fn read_from_slice(buf: &[u8]) -> Result<Output, Error>

Reads Self from a &[u8].

impl Reader<BE<i64>> for BE<i64>

fn read(buf: &mut ByteReader) -> Result<BE<i64>, Error>

Reads Self from a ByteReader.

fn read_from_slice(buf: &[u8]) -> Result<Output, Error>

Reads Self from a &[u8].

impl Reader<BE<u128>> for BE<u128>

fn read(buf: &mut ByteReader) -> Result<BE<u128>, Error>

Reads Self from a ByteReader.

fn read_from_slice(buf: &[u8]) -> Result<Output, Error>

Reads Self from a &[u8].

impl Reader<BE<u16>> for BE<u16>

fn read(buf: &mut ByteReader) -> Result<BE<u16>, Error>

Reads Self from a ByteReader.

fn read_from_slice(buf: &[u8]) -> Result<Output, Error>

Reads Self from a &[u8].

impl Reader<BE<u24>> for BE<u24>

fn read(buf: &mut ByteReader) -> Result<BE<u24>, Error>

Reads Self from a ByteReader.

fn read_from_slice(buf: &[u8]) -> Result<Output, Error>

Reads Self from a &[u8].

impl Reader<BE<u32>> for BE<u32>

fn read(buf: &mut ByteReader) -> Result<BE<u32>, Error>

Reads Self from a ByteReader.

fn read_from_slice(buf: &[u8]) -> Result<Output, Error>

Reads Self from a &[u8].

impl Reader<BE<u64>> for BE<u64>

fn read(buf: &mut ByteReader) -> Result<BE<u64>, Error>

Reads Self from a ByteReader.

fn read_from_slice(buf: &[u8]) -> Result<Output, Error>

Reads Self from a &[u8].

impl Writer for BE<f32>

fn write(&self, buf: &mut ByteWriter) -> Result<(), Error>

Writes Self to a ByteWriter.

fn write_to_bytes(&self) -> Result<ByteWriter, Error>

This is a utility function to write Self to a ByteWriter without needing to create a ByteWriter first.

impl Writer for BE<f64>

fn write(&self, buf: &mut ByteWriter) -> Result<(), Error>

Writes Self to a ByteWriter.

fn write_to_bytes(&self) -> Result<ByteWriter, Error>

This is a utility function to write Self to a ByteWriter without needing to create a ByteWriter first.

impl Writer for BE<i128>

fn write(&self, buf: &mut ByteWriter) -> Result<(), Error>

Writes Self to a ByteWriter.

fn write_to_bytes(&self) -> Result<ByteWriter, Error>

This is a utility function to write Self to a ByteWriter without needing to create a ByteWriter first.

impl Writer for BE<i16>

fn write(&self, buf: &mut ByteWriter) -> Result<(), Error>

Writes Self to a ByteWriter.

fn write_to_bytes(&self) -> Result<ByteWriter, Error>

This is a utility function to write Self to a ByteWriter without needing to create a ByteWriter first.

impl Writer for BE<i24>

fn write(&self, buf: &mut ByteWriter) -> Result<(), Error>

Writes Self to a ByteWriter.

fn write_to_bytes(&self) -> Result<ByteWriter, Error>

This is a utility function to write Self to a ByteWriter without needing to create a ByteWriter first.

impl Writer for BE<i32>

fn write(&self, buf: &mut ByteWriter) -> Result<(), Error>

Writes Self to a ByteWriter.

fn write_to_bytes(&self) -> Result<ByteWriter, Error>

This is a utility function to write Self to a ByteWriter without needing to create a ByteWriter first.

impl Writer for BE<i64>

fn write(&self, buf: &mut ByteWriter) -> Result<(), Error>

Writes Self to a ByteWriter.

fn write_to_bytes(&self) -> Result<ByteWriter, Error>

This is a utility function to write Self to a ByteWriter without needing to create a ByteWriter first.

impl Writer for BE<u128>

fn write(&self, buf: &mut ByteWriter) -> Result<(), Error>

Writes Self to a ByteWriter.

fn write_to_bytes(&self) -> Result<ByteWriter, Error>

This is a utility function to write Self to a ByteWriter without needing to create a ByteWriter first.

impl Writer for BE<u16>

fn write(&self, buf: &mut ByteWriter) -> Result<(), Error>

Writes Self to a ByteWriter.

fn write_to_bytes(&self) -> Result<ByteWriter, Error>

This is a utility function to write Self to a ByteWriter without needing to create a ByteWriter first.

impl Writer for BE<u24>

fn write(&self, buf: &mut ByteWriter) -> Result<(), Error>

Writes Self to a ByteWriter.

fn write_to_bytes(&self) -> Result<ByteWriter, Error>

This is a utility function to write Self to a ByteWriter without needing to create a ByteWriter first.

impl Writer for BE<u32>

fn write(&self, buf: &mut ByteWriter) -> Result<(), Error>

Writes Self to a ByteWriter.

fn write_to_bytes(&self) -> Result<ByteWriter, Error>

This is a utility function to write Self to a ByteWriter without needing to create a ByteWriter first.

impl Writer for BE<u64>

fn write(&self, buf: &mut ByteWriter) -> Result<(), Error>

Writes Self to a ByteWriter.

fn write_to_bytes(&self) -> Result<ByteWriter, Error>

This is a utility function to write Self to a ByteWriter without needing to create a ByteWriter first.

impl<T: Copy> Copy for BE<T>

impl<T: Eq> Eq for BE<T>

impl<T> StructuralPartialEq for BE<T>