pub struct U32<O>(/* private fields */);
Expand description
A 32-bit unsigned integer stored in a given 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
,
which can be any type which implements ByteOrder
. In particular, this refers
to BigEndian
, LittleEndian
, NativeEndian
, and NetworkEndian
.
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§
Source§impl<O> U32<O>
impl<O> U32<O>
Sourcepub const ZERO: U32<O> = _
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.
Sourcepub const MAX_VALUE: U32<O> = _
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.
Sourcepub const fn from_bytes(bytes: [u8; 4]) -> U32<O>
pub const fn from_bytes(bytes: [u8; 4]) -> U32<O>
Constructs a new value from bytes which are already in the
endianness O
.
Source§impl<O: ByteOrder> U32<O>
impl<O: ByteOrder> U32<O>
Sourcepub fn new(n: u32) -> U32<O>
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
.
Trait Implementations§
Source§impl<O: ByteOrder> AddAssign for U32<O>
impl<O: ByteOrder> AddAssign for U32<O>
Source§fn add_assign(&mut self, rhs: U32<O>)
fn add_assign(&mut self, rhs: U32<O>)
+=
operation. Read moreSource§impl<O> AsBytes for U32<O>
impl<O> AsBytes for U32<O>
Source§impl<O: ByteOrder> BitAndAssign for U32<O>
impl<O: ByteOrder> BitAndAssign for U32<O>
Source§fn bitand_assign(&mut self, rhs: U32<O>)
fn bitand_assign(&mut self, rhs: U32<O>)
&=
operation. Read moreSource§impl<O: ByteOrder> BitOrAssign for U32<O>
impl<O: ByteOrder> BitOrAssign for U32<O>
Source§fn bitor_assign(&mut self, rhs: U32<O>)
fn bitor_assign(&mut self, rhs: U32<O>)
|=
operation. Read moreSource§impl<O: ByteOrder> BitXorAssign for U32<O>
impl<O: ByteOrder> BitXorAssign for U32<O>
Source§fn bitxor_assign(&mut self, rhs: U32<O>)
fn bitxor_assign(&mut self, rhs: U32<O>)
^=
operation. Read moreSource§impl<O: ByteOrder> DivAssign for U32<O>
impl<O: ByteOrder> DivAssign for U32<O>
Source§fn div_assign(&mut self, rhs: U32<O>)
fn div_assign(&mut self, rhs: U32<O>)
/=
operation. Read moreSource§impl<O> FromBytes for U32<O>
impl<O> FromBytes for U32<O>
Source§fn mut_from_prefix(bytes: &mut [u8]) -> Option<&mut Self>
fn mut_from_prefix(bytes: &mut [u8]) -> Option<&mut Self>
Source§fn mut_from_suffix(bytes: &mut [u8]) -> Option<&mut Self>
fn mut_from_suffix(bytes: &mut [u8]) -> Option<&mut Self>
Source§fn slice_from_prefix(bytes: &[u8], count: usize) -> Option<(&[Self], &[u8])>where
Self: Sized,
fn slice_from_prefix(bytes: &[u8], count: usize) -> Option<(&[Self], &[u8])>where
Self: Sized,
bytes
as a &[Self]
with length
equal to count
without copying. Read moreSource§fn slice_from_suffix(bytes: &[u8], count: usize) -> Option<(&[u8], &[Self])>where
Self: Sized,
fn slice_from_suffix(bytes: &[u8], count: usize) -> Option<(&[u8], &[Self])>where
Self: Sized,
bytes
as a &[Self]
with length
equal to count
without copying. Read moreSource§fn mut_slice_from(bytes: &mut [u8]) -> Option<&mut [Self]>
fn mut_slice_from(bytes: &mut [u8]) -> Option<&mut [Self]>
Source§fn mut_slice_from_prefix(
bytes: &mut [u8],
count: usize,
) -> Option<(&mut [Self], &mut [u8])>
fn mut_slice_from_prefix( bytes: &mut [u8], count: usize, ) -> Option<(&mut [Self], &mut [u8])>
bytes
as a &mut [Self]
with length
equal to count
without copying. Read moreSource§fn mut_slice_from_suffix(
bytes: &mut [u8],
count: usize,
) -> Option<(&mut [u8], &mut [Self])>
fn mut_slice_from_suffix( bytes: &mut [u8], count: usize, ) -> Option<(&mut [u8], &mut [Self])>
bytes
as a &mut [Self]
with length
equal to count
without copying. Read moreSource§impl<O> FromZeroes for U32<O>
impl<O> FromZeroes for U32<O>
Source§impl<O: ByteOrder> MulAssign for U32<O>
impl<O: ByteOrder> MulAssign for U32<O>
Source§fn mul_assign(&mut self, rhs: U32<O>)
fn mul_assign(&mut self, rhs: U32<O>)
*=
operation. Read moreSource§impl<O: ByteOrder> RemAssign for U32<O>
impl<O: ByteOrder> RemAssign for U32<O>
Source§fn rem_assign(&mut self, rhs: U32<O>)
fn rem_assign(&mut self, rhs: U32<O>)
%=
operation. Read moreSource§impl<O: ByteOrder> ShlAssign for U32<O>
impl<O: ByteOrder> ShlAssign for U32<O>
Source§fn shl_assign(&mut self, rhs: U32<O>)
fn shl_assign(&mut self, rhs: U32<O>)
<<=
operation. Read moreSource§impl<O: ByteOrder> ShrAssign for U32<O>
impl<O: ByteOrder> ShrAssign for U32<O>
Source§fn shr_assign(&mut self, rhs: U32<O>)
fn shr_assign(&mut self, rhs: U32<O>)
>>=
operation. Read moreSource§impl<O: ByteOrder> SubAssign for U32<O>
impl<O: ByteOrder> SubAssign for U32<O>
Source§fn sub_assign(&mut self, rhs: U32<O>)
fn sub_assign(&mut self, rhs: U32<O>)
-=
operation. Read more