Struct zerocopy::byteorder::U16

source ·
pub struct U16<O>(/* private fields */);
Expand description

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

Implementations§

source§

impl<O> U16<O>

source

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.

source

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.

source

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

Constructs a new value from bytes which are already in the endianness O.

source§

impl<O: ByteOrder> U16<O>

source

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.

source

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.

source

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§

source§

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

source§

type Output = U16<O>

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
source§

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

source§

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

Performs the += operation. Read more
source§

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

source§

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

Gets the bytes of this value. Read more
source§

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

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

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

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

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

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

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

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

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

source§

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

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

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

source§

type Output = U16<O>

The resulting type after applying the & operator.
source§

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

Performs the & operation. Read more
source§

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

source§

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

Performs the &= operation. Read more
source§

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

source§

type Output = U16<O>

The resulting type after applying the | operator.
source§

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

Performs the | operation. Read more
source§

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

source§

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

Performs the |= operation. Read more
source§

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

source§

type Output = U16<O>

The resulting type after applying the ^ operator.
source§

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

Performs the ^ operation. Read more
source§

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

source§

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

Performs the ^= operation. Read more
source§

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

source§

fn clone(&self) -> U16<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 U16<O>

source§

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

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

impl<O> Default for U16<O>

source§

fn default() -> U16<O>

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

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

source§

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

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

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

source§

type Output = U16<O>

The resulting type after applying the / operator.
source§

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

Performs the / operation. Read more
source§

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

source§

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

Performs the /= operation. Read more
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

fn from(x: U16<O>) -> U128<P>

Converts to this type from the input type.
source§

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

source§

fn from(x: U16<O>) -> U32<P>

Converts to this type from the input type.
source§

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

source§

fn from(x: U16<O>) -> U64<P>

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

impl<O> FromBytes for U16<O>

source§

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

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

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

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,

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 + AsBytes,

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 + AsBytes,

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 + AsBytes,

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,

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,

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,

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 + AsBytes,

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 + AsBytes,

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 + AsBytes,

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> FromZeroes for U16<O>

source§

fn zero(&mut self)

Overwrites self with zeroes. 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 U16<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: ByteOrder> LowerHex for U16<O>

source§

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

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

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

source§

type Output = U16<O>

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

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

source§

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

Performs the *= operation. Read more
source§

impl<O> Not for U16<O>

source§

type Output = U16<O>

The resulting type after applying the ! operator.
source§

fn not(self) -> U16<O>

Performs the unary ! operation. Read more
source§

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

source§

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

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

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

source§

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

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

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

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

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

source§

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

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

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

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

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

source§

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

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

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

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

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

source§

type Output = U16<O>

The resulting type after applying the % operator.
source§

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

Performs the % operation. Read more
source§

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

source§

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

Performs the %= operation. Read more
source§

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

source§

type Output = U16<O>

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

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

Performs the << operation. Read more
source§

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

source§

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

Performs the <<= operation. Read more
source§

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

source§

type Output = U16<O>

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

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

Performs the >> operation. Read more
source§

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

source§

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

Performs the >>= operation. Read more
source§

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

source§

type Output = U16<O>

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

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

source§

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

Performs the -= operation. Read more
source§

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

source§

type Error = TryFromIntError

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

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

Performs the conversion.
source§

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

source§

type Error = TryFromIntError

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

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

Performs the conversion.
source§

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

source§

type Error = TryFromIntError

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

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

Performs the conversion.
source§

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

source§

type Error = TryFromIntError

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

fn try_from(x: u128) -> Result<U16<O>, TryFromIntError>

Performs the conversion.
source§

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

source§

type Error = TryFromIntError

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

fn try_from(x: u32) -> Result<U16<O>, TryFromIntError>

Performs the conversion.
source§

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

source§

type Error = TryFromIntError

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

fn try_from(x: u64) -> Result<U16<O>, TryFromIntError>

Performs the conversion.
source§

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

source§

type Error = TryFromIntError

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

fn try_from(x: usize) -> Result<U16<O>, TryFromIntError>

Performs the conversion.
source§

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

source§

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

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

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

source§

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

source§

impl<O> StructuralPartialEq for U16<O>

source§

impl<O> Unaligned for U16<O>

Auto Trait Implementations§

§

impl<O> Freeze for U16<O>

§

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

§

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

§

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

§

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

§

impl<O> UnwindSafe for U16<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> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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>,

source§

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

source§

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.