Struct I32

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

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

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

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

const ZERO: I32<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; 4]) -> I32<O>

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

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

Extracts the bytes of self without swapping the byte order.

The returned bytes will be in O byte order.

impl<O: ByteOrder> I32<O>

const fn new(n: i32) -> I32<O>

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

const fn get(self) -> i32

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

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; 4]> for I32<O>

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

impl<O> AsRef<[u8; 4]> for I32<O>

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

impl<O> Default for I32<O>

fn default() -> I32<O>

impl<O> FromBytes for I32<O> where [u8; 4]: FromBytes, PhantomData<O>: FromBytes,

impl<O> FromZeros for I32<O> where [u8; 4]: FromZeros, PhantomData<O>: FromZeros,

impl<O> Immutable for I32<O> where [u8; 4]: Immutable, PhantomData<O>: Immutable,

impl<O> IntoBytes for I32<O> where [u8; 4]: IntoBytes, PhantomData<O>: IntoBytes,

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

type PointerMetadata = ();

impl<O> Not for I32<O>

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

impl<O> PartialEq<[u8; 4]> for I32<O>

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

impl<O> TryFromBytes for I32<O> where [u8; 4]: TryFromBytes, PhantomData<O>: TryFromBytes,

impl<O> Unaligned for I32<O> where [u8; 4]: Unaligned, PhantomData<O>: Unaligned,

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

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

impl<O: ByteOrder> Add<i32> for I32<O>

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

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

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

impl<O: ByteOrder> AddAssign<i32> for I32<O>

fn add_assign(&mut self, rhs: i32)

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

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

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

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

impl<O: ByteOrder> BitAnd<i32> for I32<O>

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

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

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

impl<O: ByteOrder> BitAndAssign<i32> for I32<O>

fn bitand_assign(&mut self, rhs: i32)

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

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

impl<O: ByteOrder> BitOr<i32> for I32<O>

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

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

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

impl<O: ByteOrder> BitOrAssign<i32> for I32<O>

fn bitor_assign(&mut self, rhs: i32)

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

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

impl<O: ByteOrder> BitXor<i32> for I32<O>

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

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

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

impl<O: ByteOrder> BitXorAssign<i32> for I32<O>

fn bitxor_assign(&mut self, rhs: i32)

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

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

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

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

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

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

impl<O: ByteOrder> Div<i32> for I32<O>

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

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

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

impl<O: ByteOrder> DivAssign<i32> for I32<O>

fn div_assign(&mut self, rhs: i32)

impl<O: ByteOrder> From<[u8; 4]> for I32<O>

fn from(bytes: [u8; 4]) -> I32<O>

impl<O: ByteOrder> From<i32> for I32<O>

fn from(x: i32) -> I32<O>

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

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

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

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

impl<O: ByteOrder> Mul<i32> for I32<O>

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

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

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

impl<O: ByteOrder> MulAssign<i32> for I32<O>

fn mul_assign(&mut self, rhs: i32)

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

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

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

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

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

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

impl<O: ByteOrder> PartialEq<i32> for I32<O>

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

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

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

impl<O: ByteOrder> PartialOrd<i32> for I32<O>

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

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

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

impl<O: ByteOrder> Rem<i32> for I32<O>

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

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

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

impl<O: ByteOrder> RemAssign<i32> for I32<O>

fn rem_assign(&mut self, rhs: i32)

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

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

impl<O: ByteOrder> Shl<i32> for I32<O>

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

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

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

impl<O: ByteOrder> ShlAssign<i32> for I32<O>

fn shl_assign(&mut self, rhs: i32)

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

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

impl<O: ByteOrder> Shr<i32> for I32<O>

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

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

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

impl<O: ByteOrder> ShrAssign<i32> for I32<O>

fn shr_assign(&mut self, rhs: i32)

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

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

impl<O: ByteOrder> Sub<i32> for I32<O>

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

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

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

impl<O: ByteOrder> SubAssign<i32> for I32<O>

fn sub_assign(&mut self, rhs: i32)

impl<O: ByteOrder> TryFrom<i128> for I32<O>

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

impl<O: ByteOrder> TryFrom<i64> for I32<O>

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

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

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

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

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

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

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

impl<O: ByteOrder, P: ByteOrder> TryFrom<I64<P>> for I32<O>

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

impl<O: Clone> Clone for I32<O>

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

impl<O: Copy> Copy for I32<O>

impl<O: Eq> Eq for I32<O>

impl<O: Hash> Hash for I32<O>

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

impl<O: PartialEq> PartialEq for I32<O>

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

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

Auto Trait Implementations

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

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

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

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

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

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

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

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

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

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

impl<T> From<T> for I32<O>

fn from(t: T) -> T

Returns the argument unchanged.

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

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

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

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