Struct I16

#[repr(transparent)]
pub struct I16<O>(/* private field */, /* private field */);

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

impl<O> I16<O>

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.

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

Constructs a new value from bytes which are already in O byte order.

const fn to_bytes(self) -> [u8; 2]

Extracts the bytes of self without swapping the byte order.

The returned bytes will be in O byte order.

impl<O: ByteOrder> I16<O>

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.

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

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> AsMut<[u8; 2]> for I16<O>

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

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

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

impl<O> Default for I16<O>

fn default() -> I16<O>

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

impl<O> FromZeros for I16<O> where [u8; 2]: FromZeros, PhantomData<O>: FromZeros,

impl<O> Immutable for I16<O> where [u8; 2]: Immutable, PhantomData<O>: Immutable,

impl<O> IntoBytes for I16<O> where [u8; 2]: IntoBytes, PhantomData<O>: IntoBytes,

impl<O> KnownLayout for I16<O> where Self: Sized,

type PointerMetadata = ();

impl<O> Not for I16<O>

type Output = I16<O>;
fn not(self) -> I16<O>

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

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

impl<O> TryFromBytes for I16<O> where [u8; 2]: TryFromBytes, PhantomData<O>: TryFromBytes,

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

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

type Output = I16<O>;
fn add(self, rhs: I16<O>) -> I16<O>

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

type Output = I16<O>;
fn add(self, rhs: i16) -> I16<O>

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

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

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

fn add_assign(&mut self, rhs: i16)

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

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

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

type Output = I16<O>;
fn bitand(self, rhs: I16<O>) -> I16<O>

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

type Output = I16<O>;
fn bitand(self, rhs: i16) -> I16<O>

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

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

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

fn bitand_assign(&mut self, rhs: i16)

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

type Output = I16<O>;
fn bitor(self, rhs: I16<O>) -> I16<O>

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

type Output = I16<O>;
fn bitor(self, rhs: i16) -> I16<O>

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

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

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

fn bitor_assign(&mut self, rhs: i16)

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

type Output = I16<O>;
fn bitxor(self, rhs: I16<O>) -> I16<O>

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

type Output = I16<O>;
fn bitxor(self, rhs: i16) -> I16<O>

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

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

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

fn bitxor_assign(&mut self, rhs: i16)

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

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

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

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

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

type Output = I16<O>;
fn div(self, rhs: I16<O>) -> I16<O>

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

type Output = I16<O>;
fn div(self, rhs: i16) -> I16<O>

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

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

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

fn div_assign(&mut self, rhs: i16)

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

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

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

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

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

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

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

type Output = I16<O>;
fn mul(self, rhs: I16<O>) -> I16<O>

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

type Output = I16<O>;
fn mul(self, rhs: i16) -> I16<O>

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

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

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

fn mul_assign(&mut self, rhs: i16)

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

type Output = I16<O>;
fn neg(self) -> I16<O>

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

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

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

fn cmp(&self, other: &Self) -> Ordering

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

fn eq(&self, other: &i16) -> bool

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

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

fn partial_cmp(&self, other: &i16) -> Option<Ordering>

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

type Output = I16<O>;
fn rem(self, rhs: I16<O>) -> I16<O>

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

type Output = I16<O>;
fn rem(self, rhs: i16) -> I16<O>

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

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

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

fn rem_assign(&mut self, rhs: i16)

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

type Output = I16<O>;
fn shl(self, rhs: I16<O>) -> I16<O>

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

type Output = I16<O>;
fn shl(self, rhs: i16) -> I16<O>

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

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

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

fn shl_assign(&mut self, rhs: i16)

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

type Output = I16<O>;
fn shr(self, rhs: I16<O>) -> I16<O>

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

type Output = I16<O>;
fn shr(self, rhs: i16) -> I16<O>

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

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

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

fn shr_assign(&mut self, rhs: i16)

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

type Output = I16<O>;
fn sub(self, rhs: I16<O>) -> I16<O>

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

type Output = I16<O>;
fn sub(self, rhs: i16) -> I16<O>

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

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

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

fn sub_assign(&mut self, rhs: i16)

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

type Error = TryFromIntError;
fn try_from(x: i128) -> Result<I16<O>, TryFromIntError>

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

type Error = TryFromIntError;
fn try_from(x: i32) -> Result<I16<O>, TryFromIntError>

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

type Error = TryFromIntError;
fn try_from(x: i64) -> Result<I16<O>, TryFromIntError>

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

type Error = TryFromIntError;
fn try_from(x: isize) -> Result<I16<O>, TryFromIntError>

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

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

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

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

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

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

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

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

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

type Error = TryFromIntError;
fn try_from(x: Isize<P>) -> Result<I16<O>, TryFromIntError>

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

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

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

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

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

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

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

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

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

Auto Trait Implementations

impl<O> Freeze for I16<O> where PhantomData<O>: Freeze,

impl<O> RefUnwindSafe for I16<O> where PhantomData<O>: RefUnwindSafe,

impl<O> Send for I16<O> where PhantomData<O>: Send,

impl<O> Sync for I16<O> where PhantomData<O>: Sync,

impl<O> Unpin for I16<O> where PhantomData<O>: Unpin,

impl<O> UnsafeUnpin for I16<O> where PhantomData<O>: UnsafeUnpin,

impl<O> UnwindSafe for I16<O> where PhantomData<O>: UnwindSafe,

Blanket Implementations

impl<T> Any for I16<O> where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for I16<O> where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for I16<O> where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for I16<O> where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for I16<O>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for I16<O> where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom<U> for I16<O> where U: Into<T>,

type Error = never;
fn try_from(value: U) -> Result<T, never>

impl<T, U> TryInto<U> for I16<O> where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error;
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>