Struct format_struct::U16

#[repr(C)]
pub struct U16<E>(/* private fields */);

A type that wraps a byte array to be decoded into a u16.

The generic parameter represents the endianness used to decode the wrapped value. In case the value is expected to have fixed endianness, either BigEndian or LittleEndian types should be used, otherwise the Endian type.

Implementations

impl<E> U16<E>

pub const fn from_bytes(bytes: [u8; 2]) -> Self

Converts a byte array into a U16.

impl<E> U16<E>

pub const fn slice_as_byte_slice(slice: &[Self]) -> &[u8]

Converts an immutable slice of U16 into an immutable byte slice.

pub fn slice_as_byte_slice_mut(slice: &mut [Self]) -> &mut [u8]

Converts a mutable slice of U16 into a mutable byte slice.

impl U16<Endian>

pub const fn new_with_endian(value: u16, endian: Endian) -> Self

Constructs a U16 wrapper type from a u16 value using the specified endianness.

pub const fn get_with_endian(self, endian: Endian) -> u16

Extracts a u16 value from a U16 wrapper using the specified endianness.

impl<E: FixedEndian> U16<E>

pub const fn new(value: u16) -> Self

Constructs a U16 wrapper type from a u16 value using the type’s fixed endianness.

pub const fn get(self) -> u16

Extracts a u16 value from a U16 wrapper using the type’s fixed endianness.

Trait Implementations

impl<E: Clone> Clone for U16<E>

fn clone(&self) -> U16<E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Debug> Debug for U16<E>

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

Formats the value using the given formatter.

impl<E> Default for U16<E>

fn default() -> Self

Returns the “default value” for a type.

impl<E: FixedEndian> From<u16> for U16<E>

fn from(value: u16) -> Self

Converts to this type from the input type.

impl<E> FromByteSlice for U16<E>

fn from_byte_slice(s: &[u8]) -> Result<&Self, InvalidSizeError>

Transmutes an immutable byte slice reference into an immutable Self reference.

fn from_byte_slice_mut(s: &mut [u8]) -> Result<&mut Self, InvalidSizeError>

Transmutes a mutable byte slice reference into a mutable Self reference.

fn slice_from_byte_slice(s: &[u8]) -> Result<&[Self], InvalidSizeError>

Transmutes an immutable byte slice reference into an immutable to a slice of Self.

fn slice_from_byte_slice_mut( s: &mut [u8] ) -> Result<&mut [Self], InvalidSizeError>

Transmutes a mutable byte slice reference into a mutable to a slice of Self.

impl<E: Hash> Hash for U16<E>

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<E: PartialEq> PartialEq for U16<E>

fn eq(&self, other: &U16<E>) -> bool

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

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.

impl<E: Copy> Copy for U16<E>

impl<E: Eq> Eq for U16<E>

impl<E> StructuralPartialEq for U16<E>