pub struct I16<O>(/* private fields */);
Expand description
A 16-bit signed integer stored in a given byte order.
I16
is like the native i16
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
.
An I16
can be constructed using
the new
method, and its contained value can be obtained as a native
i16
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 I16
has endianness O
and that, b) the layout of i16
has
the platform’s native endianness.
I16
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> I16<O>
impl<O> I16<O>
Sourcepub const ZERO: I16<O>
pub const ZERO: I16<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 fn from_bytes(bytes: [u8; 2]) -> I16<O>
pub const fn from_bytes(bytes: [u8; 2]) -> I16<O>
Constructs a new value from bytes which are already in O
byte
order.
Source§impl<O> I16<O>where
O: ByteOrder,
impl<O> I16<O>where
O: ByteOrder,
Sourcepub const fn new(n: i16) -> I16<O>
pub const fn new(n: i16) -> I16<O>
Constructs a new value, possibly performing an endianness
swap to guarantee that the returned value has endianness
O
.
Trait Implementations§
Source§impl<O> AddAssign<i16> for I16<O>where
O: ByteOrder,
impl<O> AddAssign<i16> for I16<O>where
O: ByteOrder,
Source§fn add_assign(&mut self, rhs: i16)
fn add_assign(&mut self, rhs: i16)
+=
operation. Read moreSource§impl<O> AddAssign for I16<O>where
O: ByteOrder,
impl<O> AddAssign for I16<O>where
O: ByteOrder,
Source§fn add_assign(&mut self, rhs: I16<O>)
fn add_assign(&mut self, rhs: I16<O>)
+=
operation. Read moreSource§impl<O> BitAndAssign<i16> for I16<O>where
O: ByteOrder,
impl<O> BitAndAssign<i16> for I16<O>where
O: ByteOrder,
Source§fn bitand_assign(&mut self, rhs: i16)
fn bitand_assign(&mut self, rhs: i16)
&=
operation. Read moreSource§impl<O> BitAndAssign for I16<O>where
O: ByteOrder,
impl<O> BitAndAssign for I16<O>where
O: ByteOrder,
Source§fn bitand_assign(&mut self, rhs: I16<O>)
fn bitand_assign(&mut self, rhs: I16<O>)
&=
operation. Read moreSource§impl<O> BitOrAssign<i16> for I16<O>where
O: ByteOrder,
impl<O> BitOrAssign<i16> for I16<O>where
O: ByteOrder,
Source§fn bitor_assign(&mut self, rhs: i16)
fn bitor_assign(&mut self, rhs: i16)
|=
operation. Read moreSource§impl<O> BitOrAssign for I16<O>where
O: ByteOrder,
impl<O> BitOrAssign for I16<O>where
O: ByteOrder,
Source§fn bitor_assign(&mut self, rhs: I16<O>)
fn bitor_assign(&mut self, rhs: I16<O>)
|=
operation. Read moreSource§impl<O> BitXorAssign<i16> for I16<O>where
O: ByteOrder,
impl<O> BitXorAssign<i16> for I16<O>where
O: ByteOrder,
Source§fn bitxor_assign(&mut self, rhs: i16)
fn bitxor_assign(&mut self, rhs: i16)
^=
operation. Read moreSource§impl<O> BitXorAssign for I16<O>where
O: ByteOrder,
impl<O> BitXorAssign for I16<O>where
O: ByteOrder,
Source§fn bitxor_assign(&mut self, rhs: I16<O>)
fn bitxor_assign(&mut self, rhs: I16<O>)
^=
operation. Read moreSource§impl<O> DivAssign<i16> for I16<O>where
O: ByteOrder,
impl<O> DivAssign<i16> for I16<O>where
O: ByteOrder,
Source§fn div_assign(&mut self, rhs: i16)
fn div_assign(&mut self, rhs: i16)
/=
operation. Read moreSource§impl<O> DivAssign for I16<O>where
O: ByteOrder,
impl<O> DivAssign for I16<O>where
O: ByteOrder,
Source§fn div_assign(&mut self, rhs: I16<O>)
fn div_assign(&mut self, rhs: I16<O>)
/=
operation. Read moreSource§impl<O> FromBytes for I16<O>
impl<O> FromBytes for I16<O>
Source§fn ref_from_bytes(
source: &[u8],
) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>where
Self: KnownLayout + Immutable,
fn ref_from_bytes(
source: &[u8],
) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>where
Self: KnownLayout + Immutable,
Source§fn ref_from_prefix(
source: &[u8],
) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>where
Self: KnownLayout + Immutable,
fn ref_from_prefix(
source: &[u8],
) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>where
Self: KnownLayout + Immutable,
Source§fn ref_from_suffix(
source: &[u8],
) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>where
Self: Immutable + KnownLayout,
fn ref_from_suffix(
source: &[u8],
) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>where
Self: Immutable + KnownLayout,
&Self
. Read moreSource§fn mut_from_bytes(
source: &mut [u8],
) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>where
Self: IntoBytes + KnownLayout,
fn mut_from_bytes(
source: &mut [u8],
) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>where
Self: IntoBytes + KnownLayout,
Source§fn mut_from_prefix(
source: &mut [u8],
) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>where
Self: IntoBytes + KnownLayout,
fn mut_from_prefix(
source: &mut [u8],
) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>where
Self: IntoBytes + KnownLayout,
Source§fn mut_from_suffix(
source: &mut [u8],
) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>where
Self: IntoBytes + KnownLayout,
fn mut_from_suffix(
source: &mut [u8],
) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>where
Self: IntoBytes + KnownLayout,
Source§fn ref_from_bytes_with_elems(
source: &[u8],
count: usize,
) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>
fn ref_from_bytes_with_elems( source: &[u8], count: usize, ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>
Source§fn ref_from_prefix_with_elems(
source: &[u8],
count: usize,
) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>
fn ref_from_prefix_with_elems( source: &[u8], count: usize, ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>
Source§fn ref_from_suffix_with_elems(
source: &[u8],
count: usize,
) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>
fn ref_from_suffix_with_elems( source: &[u8], count: usize, ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>
Source§fn mut_from_bytes_with_elems(
source: &mut [u8],
count: usize,
) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>
fn mut_from_bytes_with_elems( source: &mut [u8], count: usize, ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>
Source§fn mut_from_prefix_with_elems(
source: &mut [u8],
count: usize,
) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>
fn mut_from_prefix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>
Source§fn mut_from_suffix_with_elems(
source: &mut [u8],
count: usize,
) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>
fn mut_from_suffix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>
Source§impl<O> IntoBytes for I16<O>
impl<O> IntoBytes for I16<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 I16<O>
impl<O> KnownLayout for I16<O>
Source§type PointerMetadata = ()
type PointerMetadata = ()
Self
. Read moreSource§impl<O> MulAssign<i16> for I16<O>where
O: ByteOrder,
impl<O> MulAssign<i16> for I16<O>where
O: ByteOrder,
Source§fn mul_assign(&mut self, rhs: i16)
fn mul_assign(&mut self, rhs: i16)
*=
operation. Read moreSource§impl<O> MulAssign for I16<O>where
O: ByteOrder,
impl<O> MulAssign for I16<O>where
O: ByteOrder,
Source§fn mul_assign(&mut self, rhs: I16<O>)
fn mul_assign(&mut self, rhs: I16<O>)
*=
operation. Read moreSource§impl<O> Ord for I16<O>where
O: ByteOrder,
impl<O> Ord for I16<O>where
O: ByteOrder,
Source§impl<O> PartialOrd<i16> for I16<O>where
O: ByteOrder,
impl<O> PartialOrd<i16> for I16<O>where
O: ByteOrder,
Source§impl<O> PartialOrd for I16<O>where
O: ByteOrder,
impl<O> PartialOrd for I16<O>where
O: ByteOrder,
Source§impl<O> RemAssign<i16> for I16<O>where
O: ByteOrder,
impl<O> RemAssign<i16> for I16<O>where
O: ByteOrder,
Source§fn rem_assign(&mut self, rhs: i16)
fn rem_assign(&mut self, rhs: i16)
%=
operation. Read moreSource§impl<O> RemAssign for I16<O>where
O: ByteOrder,
impl<O> RemAssign for I16<O>where
O: ByteOrder,
Source§fn rem_assign(&mut self, rhs: I16<O>)
fn rem_assign(&mut self, rhs: I16<O>)
%=
operation. Read moreSource§impl<O> ShlAssign<i16> for I16<O>where
O: ByteOrder,
impl<O> ShlAssign<i16> for I16<O>where
O: ByteOrder,
Source§fn shl_assign(&mut self, rhs: i16)
fn shl_assign(&mut self, rhs: i16)
<<=
operation. Read moreSource§impl<O> ShlAssign for I16<O>where
O: ByteOrder,
impl<O> ShlAssign for I16<O>where
O: ByteOrder,
Source§fn shl_assign(&mut self, rhs: I16<O>)
fn shl_assign(&mut self, rhs: I16<O>)
<<=
operation. Read moreSource§impl<O> ShrAssign<i16> for I16<O>where
O: ByteOrder,
impl<O> ShrAssign<i16> for I16<O>where
O: ByteOrder,
Source§fn shr_assign(&mut self, rhs: i16)
fn shr_assign(&mut self, rhs: i16)
>>=
operation. Read moreSource§impl<O> ShrAssign for I16<O>where
O: ByteOrder,
impl<O> ShrAssign for I16<O>where
O: ByteOrder,
Source§fn shr_assign(&mut self, rhs: I16<O>)
fn shr_assign(&mut self, rhs: I16<O>)
>>=
operation. Read moreSource§impl<O> SubAssign<i16> for I16<O>where
O: ByteOrder,
impl<O> SubAssign<i16> for I16<O>where
O: ByteOrder,
Source§fn sub_assign(&mut self, rhs: i16)
fn sub_assign(&mut self, rhs: i16)
-=
operation. Read moreSource§impl<O> SubAssign for I16<O>where
O: ByteOrder,
impl<O> SubAssign for I16<O>where
O: ByteOrder,
Source§fn sub_assign(&mut self, rhs: I16<O>)
fn sub_assign(&mut self, rhs: I16<O>)
-=
operation. Read moreSource§impl<O> TryFromBytes for I16<O>
impl<O> TryFromBytes for I16<O>
Source§fn try_ref_from_bytes(
source: &[u8],
) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>where
Self: KnownLayout + Immutable,
fn try_ref_from_bytes(
source: &[u8],
) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>where
Self: KnownLayout + Immutable,
Source§fn try_ref_from_prefix(
source: &[u8],
) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>where
Self: KnownLayout + Immutable,
fn try_ref_from_prefix(
source: &[u8],
) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>where
Self: KnownLayout + Immutable,
Source§fn try_ref_from_suffix(
source: &[u8],
) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>where
Self: KnownLayout + Immutable,
fn try_ref_from_suffix(
source: &[u8],
) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>where
Self: KnownLayout + Immutable,
Source§fn try_mut_from_bytes(
bytes: &mut [u8],
) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>where
Self: KnownLayout + IntoBytes,
fn try_mut_from_bytes(
bytes: &mut [u8],
) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>where
Self: KnownLayout + IntoBytes,
Source§fn try_mut_from_prefix(
source: &mut [u8],
) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>where
Self: KnownLayout + IntoBytes,
fn try_mut_from_prefix(
source: &mut [u8],
) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>where
Self: KnownLayout + IntoBytes,
Source§fn try_mut_from_suffix(
source: &mut [u8],
) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>where
Self: KnownLayout + IntoBytes,
fn try_mut_from_suffix(
source: &mut [u8],
) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>where
Self: KnownLayout + IntoBytes,
Source§fn try_ref_from_bytes_with_elems(
source: &[u8],
count: usize,
) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>
fn try_ref_from_bytes_with_elems( source: &[u8], count: usize, ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>
Source§fn try_ref_from_prefix_with_elems(
source: &[u8],
count: usize,
) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>
fn try_ref_from_prefix_with_elems( source: &[u8], count: usize, ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>
source
as a &Self
with
a DST length equal to count
. Read moreSource§fn try_ref_from_suffix_with_elems(
source: &[u8],
count: usize,
) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>
fn try_ref_from_suffix_with_elems( source: &[u8], count: usize, ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>
source
as a &Self
with
a DST length equal to count
. Read moreSource§fn try_mut_from_bytes_with_elems(
source: &mut [u8],
count: usize,
) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>
fn try_mut_from_bytes_with_elems( source: &mut [u8], count: usize, ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>
Source§fn try_mut_from_prefix_with_elems(
source: &mut [u8],
count: usize,
) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>
fn try_mut_from_prefix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>
source
as a &mut Self
with a DST length equal to count
. Read moreSource§fn try_mut_from_suffix_with_elems(
source: &mut [u8],
count: usize,
) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>
fn try_mut_from_suffix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>
source
as a &mut Self
with a DST length equal to count
. Read more