Struct I128

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

A 128-bit signed integer stored in a given byte order.

I128 is like the native i128 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.

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

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

const ZERO: I128<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 fn from_bytes(bytes: [u8; 16]) -> I128<O>

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

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

Extracts the bytes of self without swapping the byte order.

The returned bytes will be in O byte order.

impl<O: ByteOrder> I128<O>

const fn new(n: i128) -> I128<O>

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

const fn get(self) -> i128

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

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; 16]> for I128<O>

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

impl<O> AsRef<[u8; 16]> for I128<O>

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

impl<O> Default for I128<O>

fn default() -> I128<O>

impl<O> FromBytes for I128<O> where [u8; 16]: FromBytes, PhantomData<O>: FromBytes,

impl<O> FromZeros for I128<O> where [u8; 16]: FromZeros, PhantomData<O>: FromZeros,

impl<O> Immutable for I128<O> where [u8; 16]: Immutable, PhantomData<O>: Immutable,

impl<O> IntoBytes for I128<O> where [u8; 16]: IntoBytes, PhantomData<O>: IntoBytes,

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

type PointerMetadata = ();

impl<O> Not for I128<O>

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

impl<O> PartialEq<[u8; 16]> for I128<O>

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

impl<O> TryFromBytes for I128<O> where [u8; 16]: TryFromBytes, PhantomData<O>: TryFromBytes,

impl<O> Unaligned for I128<O> where [u8; 16]: Unaligned, PhantomData<O>: Unaligned,

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

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

impl<O: ByteOrder> Add<i128> for I128<O>

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

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

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

impl<O: ByteOrder> AddAssign<i128> for I128<O>

fn add_assign(&mut self, rhs: i128)

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

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

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

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

impl<O: ByteOrder> BitAnd<i128> for I128<O>

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

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

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

impl<O: ByteOrder> BitAndAssign<i128> for I128<O>

fn bitand_assign(&mut self, rhs: i128)

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

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

impl<O: ByteOrder> BitOr<i128> for I128<O>

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

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

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

impl<O: ByteOrder> BitOrAssign<i128> for I128<O>

fn bitor_assign(&mut self, rhs: i128)

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

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

impl<O: ByteOrder> BitXor<i128> for I128<O>

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

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

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

impl<O: ByteOrder> BitXorAssign<i128> for I128<O>

fn bitxor_assign(&mut self, rhs: i128)

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

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

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

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

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

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

impl<O: ByteOrder> Div<i128> for I128<O>

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

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

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

impl<O: ByteOrder> DivAssign<i128> for I128<O>

fn div_assign(&mut self, rhs: i128)

impl<O: ByteOrder> From<[u8; 16]> for I128<O>

fn from(bytes: [u8; 16]) -> I128<O>

impl<O: ByteOrder> From<i128> for I128<O>

fn from(x: i128) -> I128<O>

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

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

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

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

impl<O: ByteOrder> Mul<i128> for I128<O>

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

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

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

impl<O: ByteOrder> MulAssign<i128> for I128<O>

fn mul_assign(&mut self, rhs: i128)

impl<O: ByteOrder> Neg for I128<O>

type Output = I128<O>;
fn neg(self) -> I128<O>

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

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

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

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

impl<O: ByteOrder> PartialEq<i128> for I128<O>

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

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

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

impl<O: ByteOrder> PartialOrd<i128> for I128<O>

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

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

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

impl<O: ByteOrder> Rem<i128> for I128<O>

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

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

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

impl<O: ByteOrder> RemAssign<i128> for I128<O>

fn rem_assign(&mut self, rhs: i128)

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

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

impl<O: ByteOrder> Shl<i128> for I128<O>

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

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

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

impl<O: ByteOrder> ShlAssign<i128> for I128<O>

fn shl_assign(&mut self, rhs: i128)

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

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

impl<O: ByteOrder> Shr<i128> for I128<O>

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

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

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

impl<O: ByteOrder> ShrAssign<i128> for I128<O>

fn shr_assign(&mut self, rhs: i128)

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

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

impl<O: ByteOrder> Sub<i128> for I128<O>

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

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

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

impl<O: ByteOrder> SubAssign<i128> for I128<O>

fn sub_assign(&mut self, rhs: i128)

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

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

impl<O: ByteOrder, P: ByteOrder> From<I16<O>> for I128<P>

fn from(x: I16<O>) -> I128<P>

impl<O: ByteOrder, P: ByteOrder> From<I32<O>> for I128<P>

fn from(x: I32<O>) -> I128<P>

impl<O: ByteOrder, P: ByteOrder> From<I64<O>> for I128<P>

fn from(x: I64<O>) -> I128<P>

impl<O: Clone> Clone for I128<O>

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

impl<O: Copy> Copy for I128<O>

impl<O: Eq> Eq for I128<O>

impl<O: Hash> Hash for I128<O>

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

impl<O: PartialEq> PartialEq for I128<O>

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

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

Auto Trait Implementations

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

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

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

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

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

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

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

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

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

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

impl<T> From<T> for I128<O>

fn from(t: T) -> T

Returns the argument unchanged.

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

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

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

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