Struct zerocopy::byteorder::U16

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

A 16-bit unsigned integer stored in O byte order.

U16 is like the native u16 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.

A U16 can be constructed using the new method, and its contained value can be obtained as a native u16 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 U16 has endianness O and that, b) the layout of u16 has the platform's native endianness.

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

Methods

impl<O: ByteOrder> U16<O>

pub const ZERO: U16<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 MAX_VALUE: U16<O>

The maximum value.

This constant should be preferred to constructing a new value using new, as new may perform an endianness swap depending on the endianness O and the endianness of the platform.

pub fn new(n: u16) -> U16<O>

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

pub fn get(self) -> u16

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

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> FromBytes for U16<O> where
    PhantomData<O>: FromBytes, 

fn only_derive_is_allowed_to_implement_this_trait() where
    Self: Sized, 

impl<O: ByteOrder> AsBytes for U16<O>

fn only_derive_is_allowed_to_implement_this_trait() where
    Self: Sized, 

fn as_bytes(&self) -> &[u8]

Get the bytes of this value.

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

Get the bytes of this value mutably.

impl<O: ByteOrder> Unaligned for U16<O> where
    PhantomData<O>: Unaligned, 

fn only_derive_is_allowed_to_implement_this_trait() where
    Self: Sized, 

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

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

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

This method tests for !=.

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

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

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

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

This method tests for !=.

impl<O: ByteOrder> PartialEq<[u8; 2]> for U16<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] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<O: Eq + ByteOrder> Eq for U16<O>

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

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O: Default + ByteOrder> Default for U16<O>

fn default() -> U16<O>

Returns the "default value" for a type.