Struct zerocopy::byteorder::I32

#[repr(transparent)]
pub struct I32<O: ByteOrder>(_, _);

A 32-bit signed integer stored in O 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.

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, 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.

Methods

impl<O: ByteOrder> I32<O>

pub 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.

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

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

pub 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.

pub 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: ByteOrder> FromBytes for I32<O> where
    PhantomData<O>: FromBytes, 

fn only_derive_is_allowed_to_implement_this_trait() where
    Self: Sized, 

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

fn only_derive_is_allowed_to_implement_this_trait() where
    Self: Sized, 

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

Get the bytes of this value.

fn as_bytes_mut(&mut self) -> &mut [u8] where
    Self: FromBytes, 

Get the bytes of this value mutably.

impl<O: ByteOrder> Unaligned for I32<O> where
    PhantomData<O>: Unaligned, 

fn only_derive_is_allowed_to_implement_this_trait() where
    Self: Sized, 

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

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

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

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

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O: Default + ByteOrder> Default for I32<O>

fn default() -> I32<O>

Returns the "default value" for a type.