Struct zerocopy::byteorder::I16

source ·
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>

source

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.

source

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

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

source

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

source§

impl<O: ByteOrder> I16<O>

source

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.

source

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

source

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§

source§

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

§

type Output = I16<O>

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
source§

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

source§

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

Performs the += operation. Read more
source§

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

source§

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

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

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

source§

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

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

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

source§

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

Formats the value using the given formatter.
source§

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

§

type Output = I16<O>

The resulting type after applying the & operator.
source§

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

Performs the & operation. Read more
source§

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

source§

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

Performs the &= operation. Read more
source§

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

§

type Output = I16<O>

The resulting type after applying the | operator.
source§

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

Performs the | operation. Read more
source§

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

source§

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

Performs the |= operation. Read more
source§

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

§

type Output = I16<O>

The resulting type after applying the ^ operator.
source§

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

Performs the ^ operation. Read more
source§

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

source§

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

Performs the ^= operation. Read more
source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

impl<O> Default for I16<O>

source§

fn default() -> I16<O>

Returns the “default value” for a type. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

§

type Output = I16<O>

The resulting type after applying the / operator.
source§

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

Performs the / operation. Read more
source§

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

source§

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

Performs the /= operation. Read more
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

impl<O> FromBytes for I16<O>

source§

fn ref_from(bytes: &[u8]) -> Option<&Self>
where Self: NoCell + Sized,

Interprets the given bytes as a &Self without copying. Read more
source§

fn ref_from_prefix(bytes: &[u8]) -> Option<&Self>
where Self: Sized + NoCell,

Interprets the prefix of the given bytes as a &Self without copying. Read more
source§

fn ref_from_suffix(bytes: &[u8]) -> Option<&Self>
where Self: Sized + NoCell,

Interprets the suffix of the given bytes as a &Self without copying. Read more
source§

fn mut_from(bytes: &mut [u8]) -> Option<&mut Self>
where Self: Sized + IntoBytes + NoCell,

Interprets the given bytes as a &mut Self without copying. Read more
source§

fn mut_from_prefix(bytes: &mut [u8]) -> Option<&mut Self>
where Self: Sized + IntoBytes + NoCell,

Interprets the prefix of the given bytes as a &mut Self without copying. Read more
source§

fn mut_from_suffix(bytes: &mut [u8]) -> Option<&mut Self>
where Self: Sized + IntoBytes + NoCell,

Interprets the suffix of the given bytes as a &mut Self without copying. Read more
source§

fn slice_from(bytes: &[u8]) -> Option<&[Self]>
where Self: Sized + NoCell,

Interprets the given bytes as a &[Self] without copying. Read more
source§

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

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

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

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

fn mut_slice_from(bytes: &mut [u8]) -> Option<&mut [Self]>
where Self: Sized + IntoBytes + NoCell,

Interprets the given bytes as a &mut [Self] without copying. Read more
source§

fn mut_slice_from_prefix( bytes: &mut [u8], count: usize ) -> Option<(&mut [Self], &mut [u8])>
where Self: Sized + IntoBytes + NoCell,

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

fn mut_slice_from_suffix( bytes: &mut [u8], count: usize ) -> Option<(&mut [u8], &mut [Self])>
where Self: Sized + IntoBytes + NoCell,

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

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

Reads a copy of Self from bytes. Read more
source§

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

Reads a copy of Self from the prefix of bytes. Read more
source§

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

Reads a copy of Self from the suffix of bytes. Read more
source§

impl<O> FromZeros for I16<O>

source§

fn zero(&mut self)

Overwrites self with zeros. Read more
source§

fn new_zeroed() -> Self
where Self: Sized,

Creates an instance of Self from zeroed bytes. Read more
source§

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

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<O> IntoBytes for I16<O>

source§

fn as_bytes(&self) -> &[u8]
where Self: NoCell,

Gets the bytes of this value. Read more
source§

fn as_bytes_mut(&mut self) -> &mut [u8]
where Self: FromBytes + NoCell,

Gets the bytes of this value mutably. Read more
source§

fn write_to(&self, bytes: &mut [u8]) -> Option<()>
where Self: NoCell,

Writes a copy of self to bytes. Read more
source§

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

Writes a copy of self to the prefix of bytes. Read more
source§

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

Writes a copy of self to the suffix of bytes. Read more
source§

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

source§

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

Formats the value using the given formatter.
source§

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

§

type Output = I16<O>

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

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

source§

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

Performs the *= operation. Read more
source§

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

§

type Output = I16<O>

The resulting type after applying the - operator.
source§

fn neg(self) -> I16<O>

Performs the unary - operation. Read more
source§

impl<O> Not for I16<O>

§

type Output = I16<O>

The resulting type after applying the ! operator.
source§

fn not(self) -> I16<O>

Performs the unary ! operation. Read more
source§

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

source§

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

Formats the value using the given formatter.
source§

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

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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

§

type Output = I16<O>

The resulting type after applying the % operator.
source§

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

Performs the % operation. Read more
source§

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

source§

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

Performs the %= operation. Read more
source§

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

§

type Output = I16<O>

The resulting type after applying the << operator.
source§

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

Performs the << operation. Read more
source§

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

source§

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

Performs the <<= operation. Read more
source§

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

§

type Output = I16<O>

The resulting type after applying the >> operator.
source§

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

Performs the >> operation. Read more
source§

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

source§

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

Performs the >>= operation. Read more
source§

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

§

type Output = I16<O>

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

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

source§

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

Performs the -= operation. Read more
source§

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

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

source§

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

Formats the value using the given formatter.
source§

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

source§

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

source§

impl<O> StructuralPartialEq for I16<O>

source§

impl<O> Unaligned for I16<O>

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.