Struct s2n_codec::zerocopy::byteorder::I32

pub struct I32<O>(_, _)
where
         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.

Implementations

impl<O> I32<O>where O: ByteOrder,

pub const ZERO: I32<O> = I32([0u8; 4], PhantomData)

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> AsBytes for I32<O>where O: ByteOrder,

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

Gets the bytes of this value.

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

Gets the bytes of this value mutably.

fn write_to<B>(&self, bytes: B) -> Option<()>where B: ByteSliceMut,

Writes a copy of self to bytes.

fn write_to_prefix<B>(&self, bytes: B) -> Option<()>where B: ByteSliceMut,

Writes a copy of self to the prefix of bytes.

fn write_to_suffix<B>(&self, bytes: B) -> Option<()>where B: ByteSliceMut,

Writes a copy of self to the suffix of bytes.

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

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

Converts this type into a mutable reference of the (usually inferred) input type.

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

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

Converts this type into a shared reference of the (usually inferred) input type.

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

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

Formats the value using the given formatter.

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

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> Debug for I32<O>where O: ByteOrder,

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

Formats the value using the given formatter.

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

fn default() -> I32<O>

Returns the “default value” for a type.

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

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<O, P> From<I32<O>> for I64<P>where O: ByteOrder, P: ByteOrder,

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

Converts to this type from the input type.

impl<O> From<I32<O>> for i32where O: ByteOrder,

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

Converts to this type from the input type.

impl<O> From<I32<O>> for i64where O: ByteOrder,

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

fn read_from<B>(bytes: B) -> Option<Self>where B: ByteSlice, Self: Sized,

Reads a copy of Self from bytes.

fn read_from_prefix<B>(bytes: B) -> Option<Self>where B: ByteSlice, Self: Sized,

Reads a copy of Self from the prefix of bytes.

fn read_from_suffix<B>(bytes: B) -> Option<Self>where B: ByteSlice, Self: Sized,

Reads a copy of Self from the suffix of bytes.

fn new_zeroed() -> Selfwhere Self: Sized,

Creates an instance of Self from zeroed bytes.

impl<O> Hash for I32<O>where O: Hash + ByteOrder,

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

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<O, P> TryFrom<I32<P>> for I16<O>where O: ByteOrder, P: ByteOrder,

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(x: I32<P>) -> Result<I16<O>, TryFromIntError>

Performs the conversion.

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

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(x: i128) -> Result<I32<O>, TryFromIntError>

Performs the conversion.

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

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(x: i64) -> Result<I32<O>, TryFromIntError>

Performs the conversion.

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

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

Formats the value using the given formatter.

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

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

impl<O> StructuralEq for I32<O>where O: ByteOrder,

impl<O> StructuralPartialEq for I32<O>where O: ByteOrder,

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