Type Alias U16

pub type U16 = U16<NativeEndian>;

A 16-bit unsigned integer stored in native-endian byte order.

Aliased Type

struct U16(/* private fields */);

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 2 bytes

Implementations

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

Constructs a new value from bytes which are already in O byte order.

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

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

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

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> Add<u16> for U16<O>

type Output = U16<O>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = U16<O>

The resulting type after applying the + operator.

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

Performs the + operation.

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

fn add_assign(&mut self, rhs: u16)

Performs the += operation.

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

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

Performs the += operation.

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

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

Converts this type into a mutable reference of the (usually inferred) input type.

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

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

Converts this type into a shared reference of the (usually inferred) input type.

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

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

Formats the value using the given formatter.

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

type Output = U16<O>

The resulting type after applying the & operator.

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

Performs the & operation.

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

type Output = U16<O>

The resulting type after applying the & operator.

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

Performs the & operation.

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

fn bitand_assign(&mut self, rhs: u16)

Performs the &= operation.

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

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

Performs the &= operation.

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

type Output = U16<O>

The resulting type after applying the | operator.

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

Performs the | operation.

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

type Output = U16<O>

The resulting type after applying the | operator.

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

Performs the | operation.

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

fn bitor_assign(&mut self, rhs: u16)

Performs the |= operation.

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

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

Performs the |= operation.

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

type Output = U16<O>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

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

type Output = U16<O>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

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

fn bitxor_assign(&mut self, rhs: u16)

Performs the ^= operation.

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

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

Performs the ^= operation.

impl<O: Clone> 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: ByteOrder> Debug for U16<O>

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

Formats the value using the given formatter.

impl<O> Default for U16<O>

fn default() -> U16<O>

Returns the “default value” for a type.

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

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

Formats the value using the given formatter.

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

type Output = U16<O>

The resulting type after applying the / operator.

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

Performs the / operation.

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

type Output = U16<O>

The resulting type after applying the / operator.

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

Performs the / operation.

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

fn div_assign(&mut self, rhs: u16)

Performs the /= operation.

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

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

Performs the /= operation.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<O> FromBytes for U16<O>

fn ref_from_bytes(source: &[u8]) -> Result<&Self, CastError<&[u8], Self>>

where Self: KnownLayout + Immutable,

Interprets the given source as a &Self.

fn ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), CastError<&[u8], Self>>

where Self: KnownLayout + Immutable,

Interprets the prefix of the given source as a &Self without copying.

fn ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), CastError<&[u8], Self>>

where Self: Immutable + KnownLayout,

Interprets the suffix of the given bytes as a &Self.

fn mut_from_bytes( source: &mut [u8], ) -> Result<&mut Self, CastError<&mut [u8], Self>>

where Self: IntoBytes + KnownLayout,

Interprets the given source as a &mut Self.

fn mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), CastError<&mut [u8], Self>>

where Self: IntoBytes + KnownLayout,

Interprets the prefix of the given source as a &mut Self without copying.

fn mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), CastError<&mut [u8], Self>>

where Self: IntoBytes + KnownLayout,

Interprets the suffix of the given source as a &mut Self without copying.

fn read_from_bytes(source: &[u8]) -> Result<Self, SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the given source.

fn read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the prefix of the given source.

fn read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the suffix of the given source.

impl<O> FromZeros for U16<O>

fn zero(&mut self)

Overwrites self with zeros.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

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

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

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

where Self: Immutable,

Gets the bytes of this value.

fn as_mut_bytes(&mut self) -> &mut [u8]

where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to(&self, dst: &mut [u8]) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to dst.

fn write_to_prefix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the prefix of dst.

fn write_to_suffix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the suffix of dst.

impl<O> KnownLayout for U16<O>

type PointerMetadata = ()

The type of metadata stored in a pointer to Self.

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

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

Formats the value using the given formatter.

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

type Output = U16<O>

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = U16<O>

The resulting type after applying the * operator.

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

Performs the * operation.

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

fn mul_assign(&mut self, rhs: u16)

Performs the *= operation.

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

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

Performs the *= operation.

impl<O> Not for U16<O>

type Output = U16<O>

The resulting type after applying the ! operator.

fn not(self) -> U16<O>

Performs the unary ! operation.

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

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

Formats the value using the given formatter.

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

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

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

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

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

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

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

type Output = U16<O>

The resulting type after applying the % operator.

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

Performs the % operation.

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

type Output = U16<O>

The resulting type after applying the % operator.

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

Performs the % operation.

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

fn rem_assign(&mut self, rhs: u16)

Performs the %= operation.

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

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

Performs the %= operation.

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

type Output = U16<O>

The resulting type after applying the << operator.

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

Performs the << operation.

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

type Output = U16<O>

The resulting type after applying the << operator.

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

Performs the << operation.

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

fn shl_assign(&mut self, rhs: u16)

Performs the <<= operation.

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

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

Performs the <<= operation.

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

type Output = U16<O>

The resulting type after applying the >> operator.

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

Performs the >> operation.

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

type Output = U16<O>

The resulting type after applying the >> operator.

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

Performs the >> operation.

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

fn shr_assign(&mut self, rhs: u16)

Performs the >>= operation.

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

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

Performs the >>= operation.

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

type Output = U16<O>

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = U16<O>

The resulting type after applying the - operator.

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

Performs the - operation.

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

fn sub_assign(&mut self, rhs: u16)

Performs the -= operation.

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

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

Performs the -= operation.

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

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<O> TryFromBytes for U16<O>

fn try_ref_from_bytes(source: &[u8]) -> Result<&Self, TryCastError<&[u8], Self>>

where Self: KnownLayout + Immutable,

Attempts to interpret the given source as a &Self.

fn try_ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), TryCastError<&[u8], Self>>

where Self: KnownLayout + Immutable,

Attempts to interpret the prefix of the given source as a &Self.

fn try_ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), TryCastError<&[u8], Self>>

where Self: KnownLayout + Immutable,

Attempts to interpret the suffix of the given source as a &Self.

fn try_mut_from_bytes( bytes: &mut [u8], ) -> Result<&mut Self, TryCastError<&mut [u8], Self>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the given source as a &mut Self without copying.

fn try_mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), TryCastError<&mut [u8], Self>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the prefix of the given source as a &mut Self.

fn try_mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), TryCastError<&mut [u8], Self>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the suffix of the given source as a &mut Self.

fn try_read_from_bytes(source: &[u8]) -> Result<Self, TryReadError<&[u8], Self>>

where Self: Sized,

Attempts to read the given source as a Self.

fn try_read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), TryReadError<&[u8], Self>>

where Self: Sized,

Attempts to read a Self from the prefix of the given source.

fn try_read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), TryReadError<&[u8], Self>>

where Self: Sized,

Attempts to read a Self from the suffix of the given source.

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

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

Formats the value using the given formatter.

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

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

impl<O> Immutable for U16<O>

impl<O> StructuralPartialEq for U16<O>

impl<O> Unaligned for U16<O>