#[repr(transparent)]pub struct U64<O>(/* private fields */);
Expand description
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
, 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> U64<O>
impl<O> U64<O>
sourcepub const ZERO: U64<O> = _
pub 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.
sourcepub const MAX_VALUE: U64<O> = _
pub 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.
sourcepub const fn from_bytes(bytes: [u8; 8]) -> U64<O>
pub const fn from_bytes(bytes: [u8; 8]) -> U64<O>
Constructs a new value from bytes which are already in the
endianness O
.
source§impl<O: ByteOrder> U64<O>
impl<O: ByteOrder> U64<O>
sourcepub fn new(n: u64) -> U64<O>
pub fn new(n: u64) -> U64<O>
Constructs a new value, possibly performing an endianness swap
to guarantee that the returned value has endianness O
.
Trait Implementations§
source§impl<O: ByteOrder> AddAssign<U64<O>> for U64<O>
impl<O: ByteOrder> AddAssign<U64<O>> for U64<O>
source§fn add_assign(&mut self, rhs: U64<O>)
fn add_assign(&mut self, rhs: U64<O>)
+=
operation. Read moresource§impl<O> AsBytes for U64<O>where
[u8; 8]: AsBytes,
PhantomData<O>: AsBytes,
impl<O> AsBytes for U64<O>where [u8; 8]: AsBytes, PhantomData<O>: AsBytes,
source§impl<O: ByteOrder> BitAndAssign<U64<O>> for U64<O>
impl<O: ByteOrder> BitAndAssign<U64<O>> for U64<O>
source§fn bitand_assign(&mut self, rhs: U64<O>)
fn bitand_assign(&mut self, rhs: U64<O>)
&=
operation. Read moresource§impl<O: ByteOrder> BitOrAssign<U64<O>> for U64<O>
impl<O: ByteOrder> BitOrAssign<U64<O>> for U64<O>
source§fn bitor_assign(&mut self, rhs: U64<O>)
fn bitor_assign(&mut self, rhs: U64<O>)
|=
operation. Read moresource§impl<O: ByteOrder> BitXorAssign<U64<O>> for U64<O>
impl<O: ByteOrder> BitXorAssign<U64<O>> for U64<O>
source§fn bitxor_assign(&mut self, rhs: U64<O>)
fn bitxor_assign(&mut self, rhs: U64<O>)
^=
operation. Read moresource§impl<O: ByteOrder> DivAssign<U64<O>> for U64<O>
impl<O: ByteOrder> DivAssign<U64<O>> for U64<O>
source§fn div_assign(&mut self, rhs: U64<O>)
fn div_assign(&mut self, rhs: U64<O>)
/=
operation. Read moresource§impl<O> FromBytes for U64<O>where
[u8; 8]: FromBytes,
PhantomData<O>: FromBytes,
impl<O> FromBytes for U64<O>where [u8; 8]: FromBytes, PhantomData<O>: FromBytes,
source§fn slice_from_prefix(bytes: &[u8], count: usize) -> Option<(&[Self], &[u8])>where
Self: Sized,
fn slice_from_prefix(bytes: &[u8], count: usize) -> Option<(&[Self], &[u8])>where Self: Sized,
bytes
as a &[Self]
with length
equal to count
without copying. Read moresource§fn slice_from_suffix(bytes: &[u8], count: usize) -> Option<(&[u8], &[Self])>where
Self: Sized,
fn slice_from_suffix(bytes: &[u8], count: usize) -> Option<(&[u8], &[Self])>where Self: Sized,
bytes
as a &[Self]
with length
equal to count
without copying. Read moresource§fn mut_slice_from_prefix(
bytes: &mut [u8],
count: usize
) -> Option<(&mut [Self], &mut [u8])>where
Self: Sized + AsBytes,
fn mut_slice_from_prefix( bytes: &mut [u8], count: usize ) -> Option<(&mut [Self], &mut [u8])>where Self: Sized + AsBytes,
bytes
as a &mut [Self]
with length
equal to count
without copying. Read moresource§fn mut_slice_from_suffix(
bytes: &mut [u8],
count: usize
) -> Option<(&mut [u8], &mut [Self])>where
Self: Sized + AsBytes,
fn mut_slice_from_suffix( bytes: &mut [u8], count: usize ) -> Option<(&mut [u8], &mut [Self])>where Self: Sized + AsBytes,
bytes
as a &mut [Self]
with length
equal to count
without copying. Read moresource§impl<O> FromZeroes for U64<O>where
[u8; 8]: FromZeroes,
PhantomData<O>: FromZeroes,
impl<O> FromZeroes for U64<O>where [u8; 8]: FromZeroes, PhantomData<O>: FromZeroes,
source§impl<O: ByteOrder> MulAssign<U64<O>> for U64<O>
impl<O: ByteOrder> MulAssign<U64<O>> for U64<O>
source§fn mul_assign(&mut self, rhs: U64<O>)
fn mul_assign(&mut self, rhs: U64<O>)
*=
operation. Read moresource§impl<O: ByteOrder> PartialEq<[u8; 8]> for U64<O>
impl<O: ByteOrder> PartialEq<[u8; 8]> for U64<O>
source§impl<O: ByteOrder> PartialEq<U64<O>> for [u8; 8]
impl<O: ByteOrder> PartialEq<U64<O>> for [u8; 8]
source§impl<O: PartialEq> PartialEq<U64<O>> for U64<O>
impl<O: PartialEq> PartialEq<U64<O>> for U64<O>
source§impl<O: ByteOrder> RemAssign<U64<O>> for U64<O>
impl<O: ByteOrder> RemAssign<U64<O>> for U64<O>
source§fn rem_assign(&mut self, rhs: U64<O>)
fn rem_assign(&mut self, rhs: U64<O>)
%=
operation. Read moresource§impl<O: ByteOrder> ShlAssign<U64<O>> for U64<O>
impl<O: ByteOrder> ShlAssign<U64<O>> for U64<O>
source§fn shl_assign(&mut self, rhs: U64<O>)
fn shl_assign(&mut self, rhs: U64<O>)
<<=
operation. Read moresource§impl<O: ByteOrder> ShrAssign<U64<O>> for U64<O>
impl<O: ByteOrder> ShrAssign<U64<O>> for U64<O>
source§fn shr_assign(&mut self, rhs: U64<O>)
fn shr_assign(&mut self, rhs: U64<O>)
>>=
operation. Read moresource§impl<O: ByteOrder> SubAssign<U64<O>> for U64<O>
impl<O: ByteOrder> SubAssign<U64<O>> for U64<O>
source§fn sub_assign(&mut self, rhs: U64<O>)
fn sub_assign(&mut self, rhs: U64<O>)
-=
operation. Read more