Struct U128

pub struct U128<O>(/* private fields */);

A 128-bit unsigned integer stored in a given byte order.

U128 is like the native u128 type with two major differences: First, it has no alignment requirement (its alignment is 1). Second, the endianness of its memory layout is given by the type parameter O, which can be any type which implements ByteOrder. In particular, this refers to BigEndian, LittleEndian, NativeEndian, and NetworkEndian.

A U128 can be constructed using the new method, and its contained value can be obtained as a native u128 using the get method, or updated in place with the set method. In all cases, if the endianness O is not the same as the endianness of the current platform, an endianness swap will be performed in order to uphold the invariants that a) the layout of U128 has endianness O and that, b) the layout of u128 has the platform’s native endianness.

U128 implements FromBytes, AsBytes, and Unaligned, making it useful for parsing and serialization. See the module documentation for an example of how it can be used for parsing UDP packets.

Implementations

impl<O> U128<O>

pub const ZERO: U128<O>

The value zero.

This constant should be preferred to constructing a new value using new, as new may perform an endianness swap depending on the endianness and platform.

pub const MAX_VALUE: U128<O>

The maximum value.

This constant should be preferred to constructing a new value using new, as new may perform an endianness swap depending on the endianness O and the endianness of the platform.

pub const fn from_bytes(bytes: [u8; 16]) -> U128<O>

Constructs a new value from bytes which are already in the endianness O.

impl<O: ByteOrder> U128<O>

pub fn new(n: u128) -> U128<O>

Constructs a new value, possibly performing an endianness swap to guarantee that the returned value has endianness O.

pub fn get(self) -> u128

Returns the value as a primitive type, possibly performing an endianness swap to guarantee that the return value has the endianness of the native platform.

pub fn set(&mut self, n: u128)

Updates the value in place as a primitive type, possibly performing an endianness swap to guarantee that the stored value has the endianness O.

Trait Implementations

impl<O: ByteOrder> Add for U128<O>

type Output = U128<O>

The resulting type after applying the + operator.

fn add(self, rhs: U128<O>) -> U128<O>

Performs the + operation.

impl<O: ByteOrder> AddAssign for U128<O>

fn add_assign(&mut self, rhs: U128<O>)

Performs the += operation.

impl<O> AsBytes for U128<O>

where [u8; 16]: AsBytes, PhantomData<O>: AsBytes,

fn as_bytes(&self) -> &[u8]

Gets the bytes of this value.

fn as_bytes_mut(&mut self) -> &mut [u8]

where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to(&self, bytes: &mut [u8]) -> Option<()>

Writes a copy of self to bytes.

fn write_to_prefix(&self, bytes: &mut [u8]) -> Option<()>

Writes a copy of self to the prefix of bytes.

fn write_to_suffix(&self, bytes: &mut [u8]) -> Option<()>

Writes a copy of self to the suffix of bytes.

impl<O: ByteOrder> AsMut<[u8; 16]> for U128<O>

fn as_mut(&mut self) -> &mut [u8; 16]

Converts this type into a mutable reference of the (usually inferred) input type.

impl<O: ByteOrder> AsRef<[u8; 16]> for U128<O>

fn as_ref(&self) -> &[u8; 16]

Converts this type into a shared reference of the (usually inferred) input type.

impl<O: ByteOrder> Binary for U128<O>

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

Formats the value using the given formatter.

impl<O: ByteOrder> BitAnd for U128<O>

type Output = U128<O>

The resulting type after applying the & operator.

fn bitand(self, rhs: U128<O>) -> U128<O>

Performs the & operation.

impl<O: ByteOrder> BitAndAssign for U128<O>

fn bitand_assign(&mut self, rhs: U128<O>)

Performs the &= operation.

impl<O: ByteOrder> BitOr for U128<O>

type Output = U128<O>

The resulting type after applying the | operator.

fn bitor(self, rhs: U128<O>) -> U128<O>

Performs the | operation.

impl<O: ByteOrder> BitOrAssign for U128<O>

fn bitor_assign(&mut self, rhs: U128<O>)

Performs the |= operation.

impl<O: ByteOrder> BitXor for U128<O>

type Output = U128<O>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: U128<O>) -> U128<O>

Performs the ^ operation.

impl<O: ByteOrder> BitXorAssign for U128<O>

fn bitxor_assign(&mut self, rhs: U128<O>)

Performs the ^= operation.

impl<O: Clone> Clone for U128<O>

fn clone(&self) -> U128<O>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O: ByteOrder> Debug for U128<O>

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

Formats the value using the given formatter.

impl<O> Default for U128<O>

fn default() -> U128<O>

Returns the “default value” for a type.

impl<O: ByteOrder> Display for U128<O>

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

Formats the value using the given formatter.

impl<O: ByteOrder> Div for U128<O>

type Output = U128<O>

The resulting type after applying the / operator.

fn div(self, rhs: U128<O>) -> U128<O>

Performs the / operation.

impl<O: ByteOrder> DivAssign for U128<O>

fn div_assign(&mut self, rhs: U128<O>)

Performs the /= operation.

impl<O: ByteOrder> From<[u8; 16]> for U128<O>

fn from(bytes: [u8; 16]) -> U128<O>

Converts to this type from the input type.

impl<O: ByteOrder> From<U128<O>> for [u8; 16]

fn from(x: U128<O>) -> [u8; 16]

Converts to this type from the input type.

impl<O: ByteOrder> From<U128<O>> for u128

fn from(x: U128<O>) -> u128

Converts to this type from the input type.

impl<O: ByteOrder, P: ByteOrder> From<U16<O>> for U128<P>

fn from(x: U16<O>) -> U128<P>

Converts to this type from the input type.

impl<O: ByteOrder, P: ByteOrder> From<U32<O>> for U128<P>

fn from(x: U32<O>) -> U128<P>

Converts to this type from the input type.

impl<O: ByteOrder, P: ByteOrder> From<U64<O>> for U128<P>

fn from(x: U64<O>) -> U128<P>

Converts to this type from the input type.

impl<O: ByteOrder> From<u128> for U128<O>

fn from(x: u128) -> U128<O>

Converts to this type from the input type.

impl<O> FromBytes for U128<O>

where [u8; 16]: FromBytes, PhantomData<O>: FromBytes,

fn ref_from(bytes: &[u8]) -> Option<&Self>

where Self: Sized,

Interprets the given bytes as a &Self without copying.

fn ref_from_prefix(bytes: &[u8]) -> Option<&Self>

where Self: Sized,

Interprets the prefix of the given bytes as a &Self without copying.

fn ref_from_suffix(bytes: &[u8]) -> Option<&Self>

where Self: Sized,

Interprets the suffix of the given bytes as a &Self without copying.

fn mut_from(bytes: &mut [u8]) -> Option<&mut Self>

where Self: Sized + AsBytes,

Interprets the given bytes as a &mut Self without copying.

fn mut_from_prefix(bytes: &mut [u8]) -> Option<&mut Self>

where Self: Sized + AsBytes,

Interprets the prefix of the given bytes as a &mut Self without copying.

fn mut_from_suffix(bytes: &mut [u8]) -> Option<&mut Self>

where Self: Sized + AsBytes,

Interprets the suffix of the given bytes as a &mut Self without copying.

fn slice_from(bytes: &[u8]) -> Option<&[Self]>

where Self: Sized,

Interprets the given bytes as a &[Self] without copying.

fn slice_from_prefix(bytes: &[u8], count: usize) -> Option<(&[Self], &[u8])>

where Self: Sized,

Interprets the prefix of the given bytes as a &[Self] with length equal to count without copying.

fn slice_from_suffix(bytes: &[u8], count: usize) -> Option<(&[u8], &[Self])>

where Self: Sized,

Interprets the suffix of the given bytes as a &[Self] with length equal to count without copying.

fn mut_slice_from(bytes: &mut [u8]) -> Option<&mut [Self]>

where Self: Sized + AsBytes,

Interprets the given bytes as a &mut [Self] without copying.

fn mut_slice_from_prefix( bytes: &mut [u8], count: usize, ) -> Option<(&mut [Self], &mut [u8])>

where Self: Sized + AsBytes,

Interprets the prefix of the given bytes as a &mut [Self] with length equal to count without copying.

fn mut_slice_from_suffix( bytes: &mut [u8], count: usize, ) -> Option<(&mut [u8], &mut [Self])>

where Self: Sized + AsBytes,

Interprets the suffix of the given bytes as a &mut [Self] with length equal to count without copying.

fn read_from(bytes: &[u8]) -> Option<Self>

where Self: Sized,

Reads a copy of Self from bytes.

fn read_from_prefix(bytes: &[u8]) -> Option<Self>

where Self: Sized,

Reads a copy of Self from the prefix of bytes.

fn read_from_suffix(bytes: &[u8]) -> Option<Self>

where Self: Sized,

Reads a copy of Self from the suffix of bytes.

impl<O> FromZeroes for U128<O>

where [u8; 16]: FromZeroes, PhantomData<O>: FromZeroes,

fn zero(&mut self)

Overwrites self with zeroes.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

impl<O: Hash> Hash for U128<O>

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<O: ByteOrder> LowerHex for U128<O>

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

Formats the value using the given formatter.

impl<O: ByteOrder> Mul for U128<O>

type Output = U128<O>

The resulting type after applying the * operator.

fn mul(self, rhs: U128<O>) -> U128<O>

Performs the * operation.

impl<O: ByteOrder> MulAssign for U128<O>

fn mul_assign(&mut self, rhs: U128<O>)

Performs the *= operation.

impl<O> Not for U128<O>

type Output = U128<O>

The resulting type after applying the ! operator.

fn not(self) -> U128<O>

Performs the unary ! operation.

impl<O: ByteOrder> Octal for U128<O>

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

Formats the value using the given formatter.

impl<O: ByteOrder> PartialEq<[u8; 16]> for U128<O>

fn eq(&self, other: &[u8; 16]) -> 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<O: ByteOrder> PartialEq<U128<O>> for [u8; 16]

fn eq(&self, other: &U128<O>) -> 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<O: PartialEq> PartialEq for U128<O>

fn eq(&self, other: &U128<O>) -> 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<O: ByteOrder> Rem for U128<O>

type Output = U128<O>

The resulting type after applying the % operator.

fn rem(self, rhs: U128<O>) -> U128<O>

Performs the % operation.

impl<O: ByteOrder> RemAssign for U128<O>

fn rem_assign(&mut self, rhs: U128<O>)

Performs the %= operation.

impl<O: ByteOrder> Shl for U128<O>

type Output = U128<O>

The resulting type after applying the << operator.

fn shl(self, rhs: U128<O>) -> U128<O>

Performs the << operation.

impl<O: ByteOrder> ShlAssign for U128<O>

fn shl_assign(&mut self, rhs: U128<O>)

Performs the <<= operation.

impl<O: ByteOrder> Shr for U128<O>

type Output = U128<O>

The resulting type after applying the >> operator.

fn shr(self, rhs: U128<O>) -> U128<O>

Performs the >> operation.

impl<O: ByteOrder> ShrAssign for U128<O>

fn shr_assign(&mut self, rhs: U128<O>)

Performs the >>= operation.

impl<O: ByteOrder> Sub for U128<O>

type Output = U128<O>

The resulting type after applying the - operator.

fn sub(self, rhs: U128<O>) -> U128<O>

Performs the - operation.

impl<O: ByteOrder> SubAssign for U128<O>

fn sub_assign(&mut self, rhs: U128<O>)

Performs the -= operation.

impl<O: ByteOrder, P: ByteOrder> TryFrom<U128<P>> for U16<O>

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(x: U128<P>) -> Result<U16<O>, TryFromIntError>

Performs the conversion.

impl<O: ByteOrder, P: ByteOrder> TryFrom<U128<P>> for U32<O>

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(x: U128<P>) -> Result<U32<O>, TryFromIntError>

Performs the conversion.

impl<O: ByteOrder, P: ByteOrder> TryFrom<U128<P>> for U64<O>

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(x: U128<P>) -> Result<U64<O>, TryFromIntError>

Performs the conversion.

impl<O: ByteOrder> UpperHex for U128<O>

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

Formats the value using the given formatter.

impl<O: Copy> Copy for U128<O>

impl<O: Eq> Eq for U128<O>

impl<O> StructuralPartialEq for U128<O>

impl<O> Unaligned for U128<O>

where [u8; 16]: Unaligned, PhantomData<O>: Unaligned,