Struct s2n_codec::zerocopy::byteorder::U128

pub struct U128<O>(_, _)
where
         O: ByteOrder;

A 128-bit unsigned integer stored in O 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.

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>where O: ByteOrder,

pub const ZERO: U128<O> = U128([0u8; 16], PhantomData)

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> = U128([255u8; 16], PhantomData)

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 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> AsBytes for U128<O>where O: ByteOrder,

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<B>(&self, bytes: B) -> Option<()>where B: ByteSliceMut,

Writes a copy of self to bytes.

fn write_to_prefix<B>(&self, bytes: B) -> Option<()>where B: ByteSliceMut,

Writes a copy of self to the prefix of bytes.

fn write_to_suffix<B>(&self, bytes: B) -> Option<()>where B: ByteSliceMut,

Writes a copy of self to the suffix of bytes.

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

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

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

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

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

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

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

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

Formats the value using the given formatter.

impl<O> Clone for U128<O>where O: Clone + ByteOrder,

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> Debug for U128<O>where O: ByteOrder,

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

Formats the value using the given formatter.

impl<O> Default for U128<O>where O: Default + ByteOrder,

fn default() -> U128<O>

Returns the “default value” for a type.

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

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<O> FromBytes for U128<O>where O: ByteOrder, PhantomData<O>: FromBytes,

fn read_from<B>(bytes: B) -> Option<Self>where B: ByteSlice, Self: Sized,

Reads a copy of Self from bytes.

fn read_from_prefix<B>(bytes: B) -> Option<Self>where B: ByteSlice, Self: Sized,

Reads a copy of Self from the prefix of bytes.

fn read_from_suffix<B>(bytes: B) -> Option<Self>where B: ByteSlice, Self: Sized,

Reads a copy of Self from the suffix of bytes.

fn new_zeroed() -> Selfwhere Self: Sized,

Creates an instance of Self from zeroed bytes.

impl<O> Hash for U128<O>where O: Hash + ByteOrder,

fn hash<__H>(&self, state: &mut __H)where __H: Hasher,

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

fn eq(&self, other: &[u8; 16]) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<O> PartialEq<U128<O>> for U128<O>where O: PartialEq<O> + ByteOrder,

fn eq(&self, other: &U128<O>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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, P> TryFrom<U128<P>> for U32<O>where O: ByteOrder, P: ByteOrder,

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, P> TryFrom<U128<P>> for U64<O>where O: ByteOrder, P: ByteOrder,

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> UpperHex for U128<O>where O: ByteOrder,

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

Formats the value using the given formatter.

impl<O> Copy for U128<O>where O: Copy + ByteOrder,

impl<O> Eq for U128<O>where O: Eq + ByteOrder,

impl<O> StructuralEq for U128<O>where O: ByteOrder,

impl<O> StructuralPartialEq for U128<O>where O: ByteOrder,

impl<O> Unaligned for U128<O>where O: ByteOrder, PhantomData<O>: Unaligned,