Struct zerocopy::byteorder::Usize

pub struct Usize<O>(/* private fields */);

A word-sized unsigned integer stored in a given byte order.

Usize is like the native usize 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 Usize can be constructed using the new method, and its contained value can be obtained as a native usize 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 Usize has endianness O and that, b) the layout of usize has the platform’s native endianness.

Usize 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> Usize<O>

pub const ZERO: Usize<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: Usize<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; 8]) -> Usize<O>

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

pub const fn to_bytes(self) -> [u8; 8]

Extracts the bytes of self without swapping the byte order.

The returned bytes will be in O byte order.

impl<O: ByteOrder> Usize<O>

pub const fn new(n: usize) -> Usize<O>

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

pub const fn get(self) -> usize

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

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 for Usize<O>

type Output = Usize<O>

The resulting type after applying the + operator.

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

Performs the + operation.

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

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

Performs the += operation.

impl<O: ByteOrder> AsMut<[u8; 8]> for Usize<O>

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

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

impl<O: ByteOrder> AsRef<[u8; 8]> for Usize<O>

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

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

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

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

Formats the value using the given formatter.

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

type Output = Usize<O>

The resulting type after applying the & operator.

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

Performs the & operation.

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

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

Performs the &= operation.

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

type Output = Usize<O>

The resulting type after applying the | operator.

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

Performs the | operation.

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

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

Performs the |= operation.

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

type Output = Usize<O>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

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

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

Performs the ^= operation.

impl<O: Clone> Clone for Usize<O>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<O> Default for Usize<O>

fn default() -> Usize<O>

Returns the “default value” for a type.

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

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

Formats the value using the given formatter.

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

type Output = Usize<O>

The resulting type after applying the / operator.

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

Performs the / operation.

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

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

Performs the /= operation.

impl<O: ByteOrder> From<[u8; 8]> for Usize<O>

fn from(bytes: [u8; 8]) -> Usize<O>

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<O: ByteOrder> From<Usize<O>> for [u8; 8]

fn from(x: Usize<O>) -> [u8; 8]

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<O> FromBytes for Usize<O>

where [u8; 8]: FromBytes, PhantomData<O>: FromBytes,

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

where Self: NoCell + Sized,

Interprets the given bytes as a &Self without copying.

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

where Self: Sized + NoCell,

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

fn ref_from_suffix(bytes: &[u8]) -> Option<&Self>

where Self: Sized + NoCell,

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

fn mut_from(bytes: &mut [u8]) -> Option<&mut Self>

where Self: Sized + IntoBytes + NoCell,

Interprets the given bytes as a &mut Self without copying.

fn mut_from_prefix(bytes: &mut [u8]) -> Option<&mut Self>

where Self: Sized + IntoBytes + NoCell,

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

fn mut_from_suffix(bytes: &mut [u8]) -> Option<&mut Self>

where Self: Sized + IntoBytes + NoCell,

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

fn slice_from(bytes: &[u8]) -> Option<&[Self]>

where Self: Sized + NoCell,

Interprets the given bytes as a &[Self] without copying.

fn slice_from_prefix(bytes: &[u8], count: usize) -> Option<(&[Self], &[u8])>

where Self: Sized + NoCell,

Interprets the prefix of the given bytes as a &[Self] with length equal to count without copying.

fn slice_from_suffix(bytes: &[u8], count: usize) -> Option<(&[u8], &[Self])>

where Self: Sized + NoCell,

Interprets the suffix of the given bytes as a &[Self] with length equal to count without copying.

fn mut_slice_from(bytes: &mut [u8]) -> Option<&mut [Self]>

where Self: Sized + IntoBytes + NoCell,

Interprets the given bytes as a &mut [Self] without copying.

fn mut_slice_from_prefix( bytes: &mut [u8], count: usize ) -> Option<(&mut [Self], &mut [u8])>

where Self: Sized + IntoBytes + NoCell,

Interprets the prefix of the given bytes as a &mut [Self] with length equal to count without copying.

fn mut_slice_from_suffix( bytes: &mut [u8], count: usize ) -> Option<(&mut [u8], &mut [Self])>

where Self: Sized + IntoBytes + NoCell,

Interprets the suffix of the given bytes as a &mut [Self] with length equal to count without copying.

fn read_from(bytes: &[u8]) -> Option<Self>

where Self: Sized,

Reads a copy of Self from bytes.

fn read_from_prefix(bytes: &[u8]) -> Option<Self>

where Self: Sized,

Reads a copy of Self from the prefix of bytes.

fn read_from_suffix(bytes: &[u8]) -> Option<Self>

where Self: Sized,

Reads a copy of Self from the suffix of bytes.

impl<O> FromZeros for Usize<O>

where [u8; 8]: FromZeros, PhantomData<O>: FromZeros,

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 Usize<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 Usize<O>

where [u8; 8]: IntoBytes, PhantomData<O>: IntoBytes,

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

where Self: NoCell,

Gets the bytes of this value.

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

where Self: FromBytes + NoCell,

Gets the bytes of this value mutably.

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

where Self: NoCell,

Writes a copy of self to bytes.

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

where Self: NoCell,

Writes a copy of self to the prefix of bytes.

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

where Self: NoCell,

Writes a copy of self to the suffix of bytes.

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

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

Formats the value using the given formatter.

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

type Output = Usize<O>

The resulting type after applying the * operator.

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

Performs the * operation.

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

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

Performs the *= operation.

impl<O> Not for Usize<O>

type Output = Usize<O>

The resulting type after applying the ! operator.

fn not(self) -> Usize<O>

Performs the unary ! operation.

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

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

Formats the value using the given formatter.

impl<O: ByteOrder> PartialEq<[u8; 8]> for Usize<O>

fn eq(&self, other: &[u8; 8]) -> 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<O: ByteOrder> PartialEq<Usize<O>> for [u8; 8]

fn eq(&self, other: &Usize<O>) -> 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<O: PartialEq> PartialEq for Usize<O>

fn eq(&self, other: &Usize<O>) -> 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<O: ByteOrder> Rem for Usize<O>

type Output = Usize<O>

The resulting type after applying the % operator.

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

Performs the % operation.

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

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

Performs the %= operation.

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

type Output = Usize<O>

The resulting type after applying the << operator.

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

Performs the << operation.

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

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

Performs the <<= operation.

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

type Output = Usize<O>

The resulting type after applying the >> operator.

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

Performs the >> operation.

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

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

Performs the >>= operation.

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

type Output = Usize<O>

The resulting type after applying the - operator.

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

Performs the - operation.

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

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

Performs the -= operation.

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> UpperHex for Usize<O>

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

Formats the value using the given formatter.

impl<O: Copy> Copy for Usize<O>

impl<O: Eq> Eq for Usize<O>

impl<O> StructuralPartialEq for Usize<O>

impl<O> Unaligned for Usize<O>

where [u8; 8]: Unaligned, PhantomData<O>: Unaligned,