Struct U16

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

A 16-bit unsigned integer stored in a given 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, which can be any type which implements ByteOrder. In particular, this refers to BigEndian, LittleEndian, NativeEndian, and NetworkEndian.

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, 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> U16<O>

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.

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.

const fn from_bytes(bytes: [u8; 2]) -> U16<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> U16<O>

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

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

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

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

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

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

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

impl<O> Default for U16<O>

fn default() -> U16<O>

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

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

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

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

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

type PointerMetadata = ();

impl<O> Not for U16<O>

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

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

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

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

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

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

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

impl<O: ByteOrder> Add<u16> for U16<O>

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

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

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

impl<O: ByteOrder> AddAssign<u16> for U16<O>

fn add_assign(&mut self, rhs: u16)

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

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

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

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

impl<O: ByteOrder> BitAnd<u16> for U16<O>

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

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

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

impl<O: ByteOrder> BitAndAssign<u16> for U16<O>

fn bitand_assign(&mut self, rhs: u16)

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

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

impl<O: ByteOrder> BitOr<u16> for U16<O>

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

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

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

impl<O: ByteOrder> BitOrAssign<u16> for U16<O>

fn bitor_assign(&mut self, rhs: u16)

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

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

impl<O: ByteOrder> BitXor<u16> for U16<O>

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

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

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

impl<O: ByteOrder> BitXorAssign<u16> for U16<O>

fn bitxor_assign(&mut self, rhs: u16)

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

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

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

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

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

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

impl<O: ByteOrder> Div<u16> for U16<O>

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

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

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

impl<O: ByteOrder> DivAssign<u16> for U16<O>

fn div_assign(&mut self, rhs: u16)

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

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

impl<O: ByteOrder> From<u16> for U16<O>

fn from(x: u16) -> U16<O>

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

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

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

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

impl<O: ByteOrder> Mul<u16> for U16<O>

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

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

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

impl<O: ByteOrder> MulAssign<u16> for U16<O>

fn mul_assign(&mut self, rhs: u16)

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

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

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

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

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

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

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

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

impl<O: ByteOrder> PartialOrd<u16> for U16<O>

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

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

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

impl<O: ByteOrder> Rem<u16> for U16<O>

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

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

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

impl<O: ByteOrder> RemAssign<u16> for U16<O>

fn rem_assign(&mut self, rhs: u16)

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

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

impl<O: ByteOrder> Shl<u16> for U16<O>

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

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

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

impl<O: ByteOrder> ShlAssign<u16> for U16<O>

fn shl_assign(&mut self, rhs: u16)

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

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

impl<O: ByteOrder> Shr<u16> for U16<O>

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

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

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

impl<O: ByteOrder> ShrAssign<u16> for U16<O>

fn shr_assign(&mut self, rhs: u16)

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

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

impl<O: ByteOrder> Sub<u16> for U16<O>

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

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

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

impl<O: ByteOrder> SubAssign<u16> for U16<O>

fn sub_assign(&mut self, rhs: u16)

impl<O: ByteOrder> TryFrom<u128> for U16<O>

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

impl<O: ByteOrder> TryFrom<u32> for U16<O>

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

impl<O: ByteOrder> TryFrom<u64> for U16<O>

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

impl<O: ByteOrder> TryFrom<usize> for U16<O>

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

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

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

impl<O: ByteOrder, P: ByteOrder> TryFrom<U128<P>> for U16<O>

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

impl<O: ByteOrder, P: ByteOrder> TryFrom<U32<P>> for U16<O>

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

impl<O: ByteOrder, P: ByteOrder> TryFrom<U64<P>> for U16<O>

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

impl<O: ByteOrder, P: ByteOrder> TryFrom<Usize<P>> for U16<O>

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

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

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

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

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

impl<O: Hash> Hash for U16<O>

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

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

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

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

Auto Trait Implementations

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

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

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

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

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

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

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

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

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

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

impl<T> From<T> for U16<O>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for U16<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 U16<O> where U: Into<T>,

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

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

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