Struct s2n_codec::zerocopy::U32

#[repr(transparent)]
pub struct U32<O>(_, _)
 where
    O: ByteOrder;

A 32-bit unsigned integer stored in O byte order.

U32 is like the native u32 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 U32 can be constructed using the new method, and its contained value can be obtained as a native u32 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 U32 has endianness O and that, b) the layout of u32 has the platform’s native endianness.

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

pub const ZERO: U32<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: U32<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 fn new(n: u32) -> U32<O>

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

pub fn get(self) -> u32

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: u32)

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

pub fn only_derive_is_allowed_to_implement_this_trait() where
    U32<O>: Sized, 

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; 4]> for U32<O> where
    O: ByteOrder, 

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

Performs the conversion.

impl<O> AsRef<[u8; 4]> for U32<O> where
    O: ByteOrder, 

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

Performs the conversion.

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

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

Formats the value using the given formatter.

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

pub fn clone(&self) -> U32<O>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O> Debug for U32<O> where
    O: ByteOrder, 

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

Formats the value using the given formatter.

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

pub fn default() -> U32<O>

Returns the “default value” for a type.

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

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

Formats the value using the given formatter.

impl<O> From<[u8; 4]> for U32<O> where
    O: ByteOrder, 

pub fn from(bytes: [u8; 4]) -> U32<O>

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<O> From<u32> for U32<O> where
    O: ByteOrder, 

pub fn from(x: u32) -> U32<O>

Performs the conversion.

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

pub fn only_derive_is_allowed_to_implement_this_trait() where
    U32<O>: Sized, 

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

Reads a copy of Self from bytes.

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

Reads a copy of Self from the prefix of bytes.

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

Reads a copy of Self from the suffix of bytes.

fn new_zeroed() -> Self

Creates an instance of Self from zeroed bytes.

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

pub 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, 

Feeds a slice of this type into the given Hasher.

impl<O> LowerHex for U32<O> where
    O: ByteOrder, 

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

impl<O> PartialEq<[u8; 4]> for U32<O> where
    O: ByteOrder, 

pub fn eq(&self, other: &[u8; 4]) -> 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 !=.

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

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

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

pub fn ne(&self, other: &U32<O>) -> bool

This method tests for !=.

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.

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

Performs the conversion.

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

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<O, P> TryFrom<U64<P>> for U32<O> where
    O: ByteOrder,
    P: ByteOrder, 

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<O> TryFrom<u128> for U32<O> where
    O: ByteOrder, 

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(x: u128) -> Result<U32<O>, TryFromIntError>

Performs the conversion.

impl<O> TryFrom<u64> for U32<O> where
    O: ByteOrder, 

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(x: u64) -> Result<U32<O>, TryFromIntError>

Performs the conversion.

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

pub fn only_derive_is_allowed_to_implement_this_trait() where
    U32<O>: Sized, 

impl<O> UpperHex for U32<O> where
    O: ByteOrder, 

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

Formats the value using the given formatter.

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

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

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

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