[][src]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>[src]

pub const ZERO: I32<O>[src]

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>[src]

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

pub fn get(self) -> i32[src]

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)[src]

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> AsBytes for I32<O>[src]

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

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

impl<O: ByteOrder> Binary for I32<O>[src]

impl<O: Clone + ByteOrder> Clone for I32<O>[src]

impl<O: Copy + ByteOrder> Copy for I32<O>[src]

impl<O: ByteOrder> Debug for I32<O>[src]

impl<O: Default + ByteOrder> Default for I32<O>[src]

impl<O: ByteOrder> Display for I32<O>[src]

impl<O: Eq + ByteOrder> Eq for I32<O>[src]

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

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

impl<O: ByteOrder> FromBytes for I32<O> where
    PhantomData<O>: FromBytes
[src]

impl<O: Hash + ByteOrder> Hash for I32<O>[src]

impl<O: ByteOrder> LowerHex for I32<O>[src]

impl<O: ByteOrder> Octal for I32<O>[src]

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

impl<O: PartialEq + ByteOrder> PartialEq<I32<O>> for I32<O>[src]

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

impl<O: ByteOrder> StructuralEq for I32<O>[src]

impl<O: ByteOrder> StructuralPartialEq for I32<O>[src]

impl<O: ByteOrder> Unaligned for I32<O> where
    PhantomData<O>: Unaligned
[src]

impl<O: ByteOrder> UpperHex for I32<O>[src]

Auto Trait Implementations

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

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

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

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.