Struct heed_types::integer::I16

#[repr(transparent)]pub struct I16<O: ByteOrder>(_, _);

A 16-bit signed integer stored in O 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.

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 Zeroable, and Pod, making it useful for parsing and serialization.

Implementations

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Formats the value using the given formatter.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

impl<O: Default + ByteOrder> 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: Eq + ByteOrder> Eq for I16<O>

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

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

Performs the conversion.

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

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

Feeds this value into the given Hasher.

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

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

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

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

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

This method tests for !=.

impl<O: 'static + ByteOrder> Pod for I16<O>

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

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

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

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

Formats the value using the given formatter.

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

fn zeroed() -> I16<O>

Calls zeroed.