Struct U64

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

A 64-bit unsigned integer stored in a given byte order.

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

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

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

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

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

const fn new(n: u64) -> U64<O>

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

const fn get(self) -> u64

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

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; 8]> for U64<O>

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

impl<O> AsRef<[u8; 8]> for U64<O>

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

impl<O> Default for U64<O>

fn default() -> U64<O>

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

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

impl<O> Immutable for U64<O> where [u8; 8]: Immutable, PhantomData<O>: Immutable,

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

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

type PointerMetadata = ();

impl<O> Not for U64<O>

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

impl<O> PartialEq<[u8; 8]> for U64<O>

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

impl<O> TryFromBytes for U64<O> where [u8; 8]: TryFromBytes, PhantomData<O>: TryFromBytes,

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

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

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

impl<O: ByteOrder> Add<u64> for U64<O>

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

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

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

impl<O: ByteOrder> AddAssign<u64> for U64<O>

fn add_assign(&mut self, rhs: u64)

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

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

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

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

impl<O: ByteOrder> BitAnd<u64> for U64<O>

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

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

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

impl<O: ByteOrder> BitAndAssign<u64> for U64<O>

fn bitand_assign(&mut self, rhs: u64)

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

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

impl<O: ByteOrder> BitOr<u64> for U64<O>

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

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

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

impl<O: ByteOrder> BitOrAssign<u64> for U64<O>

fn bitor_assign(&mut self, rhs: u64)

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

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

impl<O: ByteOrder> BitXor<u64> for U64<O>

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

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

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

impl<O: ByteOrder> BitXorAssign<u64> for U64<O>

fn bitxor_assign(&mut self, rhs: u64)

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

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

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

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

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

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

impl<O: ByteOrder> Div<u64> for U64<O>

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

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

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

impl<O: ByteOrder> DivAssign<u64> for U64<O>

fn div_assign(&mut self, rhs: u64)

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

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

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

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

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

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

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

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

impl<O: ByteOrder> Mul<u64> for U64<O>

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

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

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

impl<O: ByteOrder> MulAssign<u64> for U64<O>

fn mul_assign(&mut self, rhs: u64)

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

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

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

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

impl<O: ByteOrder> PartialEq<u64> for U64<O>

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

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

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

impl<O: ByteOrder> PartialOrd<u64> for U64<O>

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

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

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

impl<O: ByteOrder> Rem<u64> for U64<O>

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

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

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

impl<O: ByteOrder> RemAssign<u64> for U64<O>

fn rem_assign(&mut self, rhs: u64)

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

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

impl<O: ByteOrder> Shl<u64> for U64<O>

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

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

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

impl<O: ByteOrder> ShlAssign<u64> for U64<O>

fn shl_assign(&mut self, rhs: u64)

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

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

impl<O: ByteOrder> Shr<u64> for U64<O>

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

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

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

impl<O: ByteOrder> ShrAssign<u64> for U64<O>

fn shr_assign(&mut self, rhs: u64)

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

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

impl<O: ByteOrder> Sub<u64> for U64<O>

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

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

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

impl<O: ByteOrder> SubAssign<u64> for U64<O>

fn sub_assign(&mut self, rhs: u64)

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

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

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

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

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

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

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

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

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

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

impl<O: Clone> Clone for U64<O>

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

impl<O: Copy> Copy for U64<O>

impl<O: Eq> Eq for U64<O>

impl<O: Hash> Hash for U64<O>

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

impl<O: PartialEq> PartialEq for U64<O>

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

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

Auto Trait Implementations

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

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

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

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

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

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

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

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

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

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

impl<T> From<T> for U64<O>

fn from(t: T) -> T

Returns the argument unchanged.

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

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

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

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