Struct I16

pub struct I16<O>(/* private fields */);

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

pub const fn from_bytes(bytes: [u8; 2]) -> I16<O>

Constructs a new value from bytes which are already in the endianness O.

impl<O: ByteOrder> I16<O>

pub fn new(n: i16) -> I16<O>

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

pub fn get(self) -> i16

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

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: ByteOrder> Add for I16<O>

type Output = I16<O>

The resulting type after applying the + operator.

fn add(self, rhs: I16<O>) -> I16<O>

Performs the + operation.

impl<O: ByteOrder> AddAssign for I16<O>

fn add_assign(&mut self, rhs: I16<O>)

Performs the += operation.

impl<O> AsBytes for I16<O>

where [u8; 2]: AsBytes, PhantomData<O>: AsBytes,

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(&self, bytes: &mut [u8]) -> Option<()>

Writes a copy of self to bytes.

fn write_to_prefix(&self, bytes: &mut [u8]) -> Option<()>

Writes a copy of self to the prefix of bytes.

fn write_to_suffix(&self, bytes: &mut [u8]) -> Option<()>

Writes a copy of self to the suffix of bytes.

impl<O: ByteOrder> AsMut<[u8; 2]> for I16<O>

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

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

impl<O: ByteOrder> AsRef<[u8; 2]> for I16<O>

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

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

impl<O: ByteOrder> Binary for I16<O>

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

Formats the value using the given formatter.

impl<O: ByteOrder> BitAnd for I16<O>

type Output = I16<O>

The resulting type after applying the & operator.

fn bitand(self, rhs: I16<O>) -> I16<O>

Performs the & operation.

impl<O: ByteOrder> BitAndAssign for I16<O>

fn bitand_assign(&mut self, rhs: I16<O>)

Performs the &= operation.

impl<O: ByteOrder> BitOr for I16<O>

type Output = I16<O>

The resulting type after applying the | operator.

fn bitor(self, rhs: I16<O>) -> I16<O>

Performs the | operation.

impl<O: ByteOrder> BitOrAssign for I16<O>

fn bitor_assign(&mut self, rhs: I16<O>)

Performs the |= operation.

impl<O: ByteOrder> BitXor for I16<O>

type Output = I16<O>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: I16<O>) -> I16<O>

Performs the ^ operation.

impl<O: ByteOrder> BitXorAssign for I16<O>

fn bitxor_assign(&mut self, rhs: I16<O>)

Performs the ^= operation.

impl<O: Clone> Clone for I16<O>

fn clone(&self) -> I16<O>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O: ByteOrder> Debug for I16<O>

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

Formats the value using the given formatter.

impl<O> Default for I16<O>

fn default() -> I16<O>

Returns the “default value” for a type.

impl<O: ByteOrder> Display for I16<O>

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

Formats the value using the given formatter.

impl<O: ByteOrder> Div for I16<O>

type Output = I16<O>

The resulting type after applying the / operator.

fn div(self, rhs: I16<O>) -> I16<O>

Performs the / operation.

impl<O: ByteOrder> DivAssign for I16<O>

fn div_assign(&mut self, rhs: I16<O>)

Performs the /= operation.

impl<O: ByteOrder> From<[u8; 2]> for I16<O>

fn from(bytes: [u8; 2]) -> I16<O>

Converts to this type from the input type.

impl<O: ByteOrder> From<I16<O>> for [u8; 2]

fn from(x: I16<O>) -> [u8; 2]

Converts to this type from the input type.

impl<O: ByteOrder, P: ByteOrder> From<I16<O>> for I128<P>

fn from(x: I16<O>) -> I128<P>

Converts to this type from the input type.

impl<O: ByteOrder, P: ByteOrder> From<I16<O>> for I32<P>

fn from(x: I16<O>) -> I32<P>

Converts to this type from the input type.

impl<O: ByteOrder, P: ByteOrder> From<I16<O>> for I64<P>

fn from(x: I16<O>) -> I64<P>

Converts to this type from the input type.

impl<O: ByteOrder> From<I16<O>> for i128

fn from(x: I16<O>) -> i128

Converts to this type from the input type.

impl<O: ByteOrder> From<I16<O>> for i16

fn from(x: I16<O>) -> i16

Converts to this type from the input type.

impl<O: ByteOrder> From<I16<O>> for i32

fn from(x: I16<O>) -> i32

Converts to this type from the input type.

impl<O: ByteOrder> From<I16<O>> for i64

fn from(x: I16<O>) -> i64

Converts to this type from the input type.

impl<O: ByteOrder> From<I16<O>> for isize

fn from(x: I16<O>) -> isize

Converts to this type from the input type.

impl<O: ByteOrder> From<i16> for I16<O>

fn from(x: i16) -> I16<O>

Converts to this type from the input type.

impl<O> FromBytes for I16<O>

where [u8; 2]: FromBytes, PhantomData<O>: FromBytes,

fn ref_from(bytes: &[u8]) -> Option<&Self>

where Self: Sized,

Interprets the given bytes as a &Self without copying.

fn ref_from_prefix(bytes: &[u8]) -> Option<&Self>

where Self: Sized,

Interprets the prefix of the given bytes as a &Self without copying.

fn ref_from_suffix(bytes: &[u8]) -> Option<&Self>

where Self: Sized,

Interprets the suffix of the given bytes as a &Self without copying.

fn mut_from(bytes: &mut [u8]) -> Option<&mut Self>

where Self: Sized + AsBytes,

Interprets the given bytes as a &mut Self without copying.

fn mut_from_prefix(bytes: &mut [u8]) -> Option<&mut Self>

where Self: Sized + AsBytes,

Interprets the prefix of the given bytes as a &mut Self without copying.

fn mut_from_suffix(bytes: &mut [u8]) -> Option<&mut Self>

where Self: Sized + AsBytes,

Interprets the suffix of the given bytes as a &mut Self without copying.

fn slice_from(bytes: &[u8]) -> Option<&[Self]>

where Self: Sized,

Interprets the given bytes as a &[Self] without copying.

fn slice_from_prefix(bytes: &[u8], count: usize) -> Option<(&[Self], &[u8])>

where Self: Sized,

Interprets the prefix of the given bytes as a &[Self] with length equal to count without copying.

fn slice_from_suffix(bytes: &[u8], count: usize) -> Option<(&[u8], &[Self])>

where Self: Sized,

Interprets the suffix of the given bytes as a &[Self] with length equal to count without copying.

fn mut_slice_from(bytes: &mut [u8]) -> Option<&mut [Self]>

where Self: Sized + AsBytes,

Interprets the given bytes as a &mut [Self] without copying.

fn mut_slice_from_prefix( bytes: &mut [u8], count: usize, ) -> Option<(&mut [Self], &mut [u8])>

where Self: Sized + AsBytes,

Interprets the prefix of the given bytes as a &mut [Self] with length equal to count without copying.

fn mut_slice_from_suffix( bytes: &mut [u8], count: usize, ) -> Option<(&mut [u8], &mut [Self])>

where Self: Sized + AsBytes,

Interprets the suffix of the given bytes as a &mut [Self] with length equal to count without copying.

fn read_from(bytes: &[u8]) -> Option<Self>

where Self: Sized,

Reads a copy of Self from bytes.

fn read_from_prefix(bytes: &[u8]) -> Option<Self>

where Self: Sized,

Reads a copy of Self from the prefix of bytes.

fn read_from_suffix(bytes: &[u8]) -> Option<Self>

where Self: Sized,

Reads a copy of Self from the suffix of bytes.

impl<O> FromZeroes for I16<O>

where [u8; 2]: FromZeroes, PhantomData<O>: FromZeroes,

fn zero(&mut self)

Overwrites self with zeroes.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

impl<O: Hash> Hash for I16<O>

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

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: ByteOrder> LowerHex for I16<O>

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

Formats the value using the given formatter.

impl<O: ByteOrder> Mul for I16<O>

type Output = I16<O>

The resulting type after applying the * operator.

fn mul(self, rhs: I16<O>) -> I16<O>

Performs the * operation.

impl<O: ByteOrder> MulAssign for I16<O>

fn mul_assign(&mut self, rhs: I16<O>)

Performs the *= operation.

impl<O: ByteOrder> Neg for I16<O>

type Output = I16<O>

The resulting type after applying the - operator.

fn neg(self) -> I16<O>

Performs the unary - operation.

impl<O> Not for I16<O>

type Output = I16<O>

The resulting type after applying the ! operator.

fn not(self) -> I16<O>

Performs the unary ! operation.

impl<O: ByteOrder> Octal for I16<O>

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

Formats the value using the given formatter.

impl<O: ByteOrder> PartialEq<[u8; 2]> for I16<O>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<O: ByteOrder> PartialEq<I16<O>> for [u8; 2]

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<O: PartialEq> PartialEq for I16<O>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<O: ByteOrder> Rem for I16<O>

type Output = I16<O>

The resulting type after applying the % operator.

fn rem(self, rhs: I16<O>) -> I16<O>

Performs the % operation.

impl<O: ByteOrder> RemAssign for I16<O>

fn rem_assign(&mut self, rhs: I16<O>)

Performs the %= operation.

impl<O: ByteOrder> Shl for I16<O>

type Output = I16<O>

The resulting type after applying the << operator.

fn shl(self, rhs: I16<O>) -> I16<O>

Performs the << operation.

impl<O: ByteOrder> ShlAssign for I16<O>

fn shl_assign(&mut self, rhs: I16<O>)

Performs the <<= operation.

impl<O: ByteOrder> Shr for I16<O>

type Output = I16<O>

The resulting type after applying the >> operator.

fn shr(self, rhs: I16<O>) -> I16<O>

Performs the >> operation.

impl<O: ByteOrder> ShrAssign for I16<O>

fn shr_assign(&mut self, rhs: I16<O>)

Performs the >>= operation.

impl<O: ByteOrder> Sub for I16<O>

type Output = I16<O>

The resulting type after applying the - operator.

fn sub(self, rhs: I16<O>) -> I16<O>

Performs the - operation.

impl<O: ByteOrder> SubAssign for I16<O>

fn sub_assign(&mut self, rhs: I16<O>)

Performs the -= operation.

impl<O: ByteOrder, P: ByteOrder> TryFrom<I128<P>> for I16<O>

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(x: I128<P>) -> Result<I16<O>, TryFromIntError>

Performs the conversion.

impl<O: ByteOrder, P: ByteOrder> TryFrom<I32<P>> for I16<O>

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(x: I32<P>) -> Result<I16<O>, TryFromIntError>

Performs the conversion.

impl<O: ByteOrder, P: ByteOrder> TryFrom<I64<P>> for I16<O>

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(x: I64<P>) -> Result<I16<O>, TryFromIntError>

Performs the conversion.

impl<O: ByteOrder> TryFrom<i128> for I16<O>

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(x: i128) -> Result<I16<O>, TryFromIntError>

Performs the conversion.

impl<O: ByteOrder> TryFrom<i32> for I16<O>

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(x: i32) -> Result<I16<O>, TryFromIntError>

Performs the conversion.

impl<O: ByteOrder> TryFrom<i64> for I16<O>

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(x: i64) -> Result<I16<O>, TryFromIntError>

Performs the conversion.

impl<O: ByteOrder> TryFrom<isize> for I16<O>

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(x: isize) -> Result<I16<O>, TryFromIntError>

Performs the conversion.

impl<O: ByteOrder> UpperHex for I16<O>

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

Formats the value using the given formatter.

impl<O: Copy> Copy for I16<O>

impl<O: Eq> Eq for I16<O>

impl<O> StructuralPartialEq for I16<O>

impl<O> Unaligned for I16<O>

where [u8; 2]: Unaligned, PhantomData<O>: Unaligned,