Struct zerocopy::byteorder::U32

source ·
pub struct U32<O: ByteOrder>(/* private fields */);
Expand description

A 32-bit unsigned integer stored in O byte order.

U32 is like the native u32 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.

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

U32 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§

source§

impl<O: ByteOrder> U32<O>

source

pub const ZERO: U32<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.

source

pub const MAX_VALUE: U32<O> = _

The maximum value.

This constant should be preferred to constructing a new value using new, as new may perform an endianness swap depending on the endianness O and the endianness of the platform.

source

pub fn new(n: u32) -> U32<O>

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

source

pub fn get(self) -> u32

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.

source

pub fn set(&mut self, n: u32)

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§

source§

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

source§

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

Get the bytes of this value. Read more
source§

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

Get the bytes of this value mutably. Read more
source§

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

source§

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

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

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

source§

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

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

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

source§

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

Formats the value using the given formatter.
source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn default() -> U32<O>

Returns the “default value” for a type. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

impl<O: Hash + ByteOrder> Hash for U32<O>

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

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

source§

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

Formats the value using the given formatter.
source§

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

source§

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

Formats the value using the given formatter.
source§

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

source§

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

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

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.
source§

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

source§

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

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

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.
source§

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

source§

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

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

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.
source§

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

source§

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

Formats the value using the given formatter.
source§

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

source§

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

source§

impl<O: ByteOrder> FromBytes for U32<O>

source§

impl<O: ByteOrder> StructuralEq for U32<O>

source§

impl<O: ByteOrder> StructuralPartialEq for U32<O>

source§

impl<O: ByteOrder> Unaligned for U32<O>

Auto Trait Implementations§

§

impl<O> RefUnwindSafe for U32<O>
where O: RefUnwindSafe,

§

impl<O> Send for U32<O>
where O: Send,

§

impl<O> Sync for U32<O>
where O: Sync,

§

impl<O> Unpin for U32<O>
where O: Unpin,

§

impl<O> UnwindSafe for U32<O>
where O: UnwindSafe,

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.