pub struct U16<O>(/* private fields */);
Expand description
A 16-bit unsigned integer stored in a given byte order.
U16
is like the native u16
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 U16
can be constructed using
the new
method, and its contained value can be obtained as a native
u16
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 U16
has endianness O
and that, b) the layout of u16
has
the platform’s native endianness.
U16
implements FromBytes
, IntoBytes
, 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> U16<O>
impl<O> U16<O>
Sourcepub const ZERO: U16<O> = _
pub const ZERO: U16<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: U16<O> = _
pub const MAX_VALUE: U16<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; 2]) -> U16<O>
pub const fn from_bytes(bytes: [u8; 2]) -> U16<O>
Constructs a new value from bytes which are already in O
byte
order.
Source§impl<O: ByteOrder> U16<O>
impl<O: ByteOrder> U16<O>
Sourcepub const fn new(n: u16) -> U16<O>
pub const fn new(n: u16) -> U16<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<U16<O>> for u16
impl<O: ByteOrder> AddAssign<U16<O>> for u16
Source§fn add_assign(&mut self, rhs: U16<O>)
fn add_assign(&mut self, rhs: U16<O>)
+=
operation. Read moreSource§impl<O: ByteOrder> AddAssign<u16> for U16<O>
impl<O: ByteOrder> AddAssign<u16> for U16<O>
Source§fn add_assign(&mut self, rhs: u16)
fn add_assign(&mut self, rhs: u16)
+=
operation. Read moreSource§impl<O: ByteOrder> AddAssign for U16<O>
impl<O: ByteOrder> AddAssign for U16<O>
Source§fn add_assign(&mut self, rhs: U16<O>)
fn add_assign(&mut self, rhs: U16<O>)
+=
operation. Read moreSource§impl<O: ByteOrder> BitAndAssign<U16<O>> for u16
impl<O: ByteOrder> BitAndAssign<U16<O>> for u16
Source§fn bitand_assign(&mut self, rhs: U16<O>)
fn bitand_assign(&mut self, rhs: U16<O>)
&=
operation. Read moreSource§impl<O: ByteOrder> BitAndAssign<u16> for U16<O>
impl<O: ByteOrder> BitAndAssign<u16> for U16<O>
Source§fn bitand_assign(&mut self, rhs: u16)
fn bitand_assign(&mut self, rhs: u16)
&=
operation. Read moreSource§impl<O: ByteOrder> BitAndAssign for U16<O>
impl<O: ByteOrder> BitAndAssign for U16<O>
Source§fn bitand_assign(&mut self, rhs: U16<O>)
fn bitand_assign(&mut self, rhs: U16<O>)
&=
operation. Read moreSource§impl<O: ByteOrder> BitOrAssign<U16<O>> for u16
impl<O: ByteOrder> BitOrAssign<U16<O>> for u16
Source§fn bitor_assign(&mut self, rhs: U16<O>)
fn bitor_assign(&mut self, rhs: U16<O>)
|=
operation. Read moreSource§impl<O: ByteOrder> BitOrAssign<u16> for U16<O>
impl<O: ByteOrder> BitOrAssign<u16> for U16<O>
Source§fn bitor_assign(&mut self, rhs: u16)
fn bitor_assign(&mut self, rhs: u16)
|=
operation. Read moreSource§impl<O: ByteOrder> BitOrAssign for U16<O>
impl<O: ByteOrder> BitOrAssign for U16<O>
Source§fn bitor_assign(&mut self, rhs: U16<O>)
fn bitor_assign(&mut self, rhs: U16<O>)
|=
operation. Read moreSource§impl<O: ByteOrder> BitXorAssign<U16<O>> for u16
impl<O: ByteOrder> BitXorAssign<U16<O>> for u16
Source§fn bitxor_assign(&mut self, rhs: U16<O>)
fn bitxor_assign(&mut self, rhs: U16<O>)
^=
operation. Read moreSource§impl<O: ByteOrder> BitXorAssign<u16> for U16<O>
impl<O: ByteOrder> BitXorAssign<u16> for U16<O>
Source§fn bitxor_assign(&mut self, rhs: u16)
fn bitxor_assign(&mut self, rhs: u16)
^=
operation. Read moreSource§impl<O: ByteOrder> BitXorAssign for U16<O>
impl<O: ByteOrder> BitXorAssign for U16<O>
Source§fn bitxor_assign(&mut self, rhs: U16<O>)
fn bitxor_assign(&mut self, rhs: U16<O>)
^=
operation. Read moreSource§impl<O: ByteOrder> DivAssign<U16<O>> for u16
impl<O: ByteOrder> DivAssign<U16<O>> for u16
Source§fn div_assign(&mut self, rhs: U16<O>)
fn div_assign(&mut self, rhs: U16<O>)
/=
operation. Read moreSource§impl<O: ByteOrder> DivAssign<u16> for U16<O>
impl<O: ByteOrder> DivAssign<u16> for U16<O>
Source§fn div_assign(&mut self, rhs: u16)
fn div_assign(&mut self, rhs: u16)
/=
operation. Read moreSource§impl<O: ByteOrder> DivAssign for U16<O>
impl<O: ByteOrder> DivAssign for U16<O>
Source§fn div_assign(&mut self, rhs: U16<O>)
fn div_assign(&mut self, rhs: U16<O>)
/=
operation. Read moreSource§impl<O> FromBytes for U16<O>
impl<O> FromBytes for U16<O>
Source§fn ref_from_bytes(source: &[u8]) -> Result<&Self, CastError<&[u8], Self>>where
Self: KnownLayout + Immutable,
fn ref_from_bytes(source: &[u8]) -> Result<&Self, CastError<&[u8], Self>>where
Self: KnownLayout + Immutable,
Source§fn ref_from_prefix(
source: &[u8],
) -> Result<(&Self, &[u8]), CastError<&[u8], Self>>where
Self: KnownLayout + Immutable,
fn ref_from_prefix(
source: &[u8],
) -> Result<(&Self, &[u8]), CastError<&[u8], Self>>where
Self: KnownLayout + Immutable,
Source§fn ref_from_suffix(
source: &[u8],
) -> Result<(&[u8], &Self), CastError<&[u8], Self>>where
Self: Immutable + KnownLayout,
fn ref_from_suffix(
source: &[u8],
) -> Result<(&[u8], &Self), CastError<&[u8], Self>>where
Self: Immutable + KnownLayout,
&Self
. Read moreSource§fn mut_from_bytes(
source: &mut [u8],
) -> Result<&mut Self, CastError<&mut [u8], Self>>where
Self: IntoBytes + KnownLayout,
fn mut_from_bytes(
source: &mut [u8],
) -> Result<&mut Self, CastError<&mut [u8], Self>>where
Self: IntoBytes + KnownLayout,
Source§fn mut_from_prefix(
source: &mut [u8],
) -> Result<(&mut Self, &mut [u8]), CastError<&mut [u8], Self>>where
Self: IntoBytes + KnownLayout,
fn mut_from_prefix(
source: &mut [u8],
) -> Result<(&mut Self, &mut [u8]), CastError<&mut [u8], Self>>where
Self: IntoBytes + KnownLayout,
Source§fn mut_from_suffix(
source: &mut [u8],
) -> Result<(&mut [u8], &mut Self), CastError<&mut [u8], Self>>where
Self: IntoBytes + KnownLayout,
fn mut_from_suffix(
source: &mut [u8],
) -> Result<(&mut [u8], &mut Self), CastError<&mut [u8], Self>>where
Self: IntoBytes + KnownLayout,
Source§impl<O> IntoBytes for U16<O>
impl<O> IntoBytes for U16<O>
Source§fn as_mut_bytes(&mut self) -> &mut [u8]where
Self: FromBytes,
fn as_mut_bytes(&mut self) -> &mut [u8]where
Self: FromBytes,
Source§fn write_to(&self, dst: &mut [u8]) -> Result<(), SizeError<&Self, &mut [u8]>>where
Self: Immutable,
fn write_to(&self, dst: &mut [u8]) -> Result<(), SizeError<&Self, &mut [u8]>>where
Self: Immutable,
Source§impl<O> KnownLayout for U16<O>
impl<O> KnownLayout for U16<O>
Source§type PointerMetadata = ()
type PointerMetadata = ()
Self
. Read moreSource§impl<O: ByteOrder> MulAssign<U16<O>> for u16
impl<O: ByteOrder> MulAssign<U16<O>> for u16
Source§fn mul_assign(&mut self, rhs: U16<O>)
fn mul_assign(&mut self, rhs: U16<O>)
*=
operation. Read moreSource§impl<O: ByteOrder> MulAssign<u16> for U16<O>
impl<O: ByteOrder> MulAssign<u16> for U16<O>
Source§fn mul_assign(&mut self, rhs: u16)
fn mul_assign(&mut self, rhs: u16)
*=
operation. Read moreSource§impl<O: ByteOrder> MulAssign for U16<O>
impl<O: ByteOrder> MulAssign for U16<O>
Source§fn mul_assign(&mut self, rhs: U16<O>)
fn mul_assign(&mut self, rhs: U16<O>)
*=
operation. Read moreSource§impl<O: ByteOrder> Ord for U16<O>
impl<O: ByteOrder> Ord for U16<O>
Source§impl<O: ByteOrder> PartialOrd<u16> for U16<O>
impl<O: ByteOrder> PartialOrd<u16> for U16<O>
Source§impl<O: ByteOrder> PartialOrd for U16<O>
impl<O: ByteOrder> PartialOrd for U16<O>
Source§impl<O: ByteOrder> RemAssign<U16<O>> for u16
impl<O: ByteOrder> RemAssign<U16<O>> for u16
Source§fn rem_assign(&mut self, rhs: U16<O>)
fn rem_assign(&mut self, rhs: U16<O>)
%=
operation. Read moreSource§impl<O: ByteOrder> RemAssign<u16> for U16<O>
impl<O: ByteOrder> RemAssign<u16> for U16<O>
Source§fn rem_assign(&mut self, rhs: u16)
fn rem_assign(&mut self, rhs: u16)
%=
operation. Read moreSource§impl<O: ByteOrder> RemAssign for U16<O>
impl<O: ByteOrder> RemAssign for U16<O>
Source§fn rem_assign(&mut self, rhs: U16<O>)
fn rem_assign(&mut self, rhs: U16<O>)
%=
operation. Read moreSource§impl<O: ByteOrder> ShlAssign<U16<O>> for u16
impl<O: ByteOrder> ShlAssign<U16<O>> for u16
Source§fn shl_assign(&mut self, rhs: U16<O>)
fn shl_assign(&mut self, rhs: U16<O>)
<<=
operation. Read moreSource§impl<O: ByteOrder> ShlAssign<u16> for U16<O>
impl<O: ByteOrder> ShlAssign<u16> for U16<O>
Source§fn shl_assign(&mut self, rhs: u16)
fn shl_assign(&mut self, rhs: u16)
<<=
operation. Read moreSource§impl<O: ByteOrder> ShlAssign for U16<O>
impl<O: ByteOrder> ShlAssign for U16<O>
Source§fn shl_assign(&mut self, rhs: U16<O>)
fn shl_assign(&mut self, rhs: U16<O>)
<<=
operation. Read moreSource§impl<O: ByteOrder> ShrAssign<U16<O>> for u16
impl<O: ByteOrder> ShrAssign<U16<O>> for u16
Source§fn shr_assign(&mut self, rhs: U16<O>)
fn shr_assign(&mut self, rhs: U16<O>)
>>=
operation. Read moreSource§impl<O: ByteOrder> ShrAssign<u16> for U16<O>
impl<O: ByteOrder> ShrAssign<u16> for U16<O>
Source§fn shr_assign(&mut self, rhs: u16)
fn shr_assign(&mut self, rhs: u16)
>>=
operation. Read moreSource§impl<O: ByteOrder> ShrAssign for U16<O>
impl<O: ByteOrder> ShrAssign for U16<O>
Source§fn shr_assign(&mut self, rhs: U16<O>)
fn shr_assign(&mut self, rhs: U16<O>)
>>=
operation. Read moreSource§impl<O: ByteOrder> SubAssign<U16<O>> for u16
impl<O: ByteOrder> SubAssign<U16<O>> for u16
Source§fn sub_assign(&mut self, rhs: U16<O>)
fn sub_assign(&mut self, rhs: U16<O>)
-=
operation. Read moreSource§impl<O: ByteOrder> SubAssign<u16> for U16<O>
impl<O: ByteOrder> SubAssign<u16> for U16<O>
Source§fn sub_assign(&mut self, rhs: u16)
fn sub_assign(&mut self, rhs: u16)
-=
operation. Read moreSource§impl<O: ByteOrder> SubAssign for U16<O>
impl<O: ByteOrder> SubAssign for U16<O>
Source§fn sub_assign(&mut self, rhs: U16<O>)
fn sub_assign(&mut self, rhs: U16<O>)
-=
operation. Read more