Struct Unaligned

#[repr(C, packed(1))]
pub struct Unaligned<Data>(/* private fields */)
where
    Data: TrivialType;

Wrapper type for Data that is the same size, but doesn’t need to be aligned/has alignment of one byte.

This is similar to #[repr(packed)], but makes sure to only expose safe API when dealing with the contents. For example, if Data is unaligned and has fields, it is not sounds having references to its fields. This data structure prevents such invalid invariants.

Implementations

impl<Data> Unaligned<Data>

where Data: TrivialType,

pub const fn new(inner: Data) -> Self

Create a new instance

pub const fn as_inner(&self) -> Data

Get inner value

pub const fn replace(&mut self, value: Data)

Replace inner value

Trait Implementations

impl<Data> Clone for Unaligned<Data>

where Data: TrivialType + Clone + Copy,

fn clone(&self) -> Unaligned<Data>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Data> Debug for Unaligned<Data>

where Data: TrivialType + Debug + Copy,

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

Formats the value using the given formatter.

impl<Data> Decode for Unaligned<Data>

where Data: TrivialType + Decode,

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<Data> Default for Unaligned<Data>

where Data: TrivialType + Default,

fn default() -> Unaligned<Data>

Returns the “default value” for a type.

impl<'de, Data> Deserialize<'de> for Unaligned<Data>

where Data: TrivialType + Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Data> Display for Unaligned<Data>

where Data: TrivialType + Display,

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

Formats the value using the given formatter.

impl<Data> Encode for Unaligned<Data>

where Data: TrivialType + Encode,

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<T: Output + ?Sized>(&self, dest: &mut T)

Convert self to a slice and append it to the destination.

fn using_encoded<R, F: FnOnce(&[u8]) -> R>(&self, f: F) -> R

Convert self to a slice and then invoke the given closure with it.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<Data> From<Data> for Unaligned<Data>

where Data: TrivialType,

fn from(value: Data) -> Self

Converts to this type from the input type.

impl<Data> Hash for Unaligned<Data>

where Data: TrivialType + Hash + Copy,

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

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<Data> MaxEncodedLen for Unaligned<Data>

where Data: TrivialType + MaxEncodedLen,

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl<Data> Ord for Unaligned<Data>

where Data: TrivialType + Ord + Copy,

fn cmp(&self, other: &Unaligned<Data>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<Data> PartialEq for Unaligned<Data>

where Data: TrivialType + PartialEq + Copy,

fn eq(&self, other: &Unaligned<Data>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<Data> PartialOrd for Unaligned<Data>

where Data: TrivialType + PartialOrd + Copy,

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Data> Serialize for Unaligned<Data>

where Data: TrivialType + Serialize,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<Data> TrivialType for Unaligned<Data>

where Data: TrivialType,

const METADATA: &[u8]

Data structure metadata in binary form, describing shape and types of the contents, see IoTypeMetadataKind for encoding details.

const SIZE: u32 = _

unsafe fn from_bytes(bytes: &[u8]) -> Option<&Self>

Create a reference to a type, which is represented by provided memory.

unsafe fn from_bytes_mut(bytes: &mut [u8]) -> Option<&mut Self>

Create a mutable reference to a type, which is represented by provided memory.

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

Access the underlying byte representation of a data structure

unsafe fn as_bytes_mut(&mut self) -> &mut [u8]

Access the underlying mutable byte representation of a data structure.

impl<Data> TypeInfo for Unaligned<Data>

where Data: TrivialType + TypeInfo + 'static,

type Identity = Unaligned<Data>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<Data> Copy for Unaligned<Data>

where Data: TrivialType + Copy,

impl<Data> EncodeLike for Unaligned<Data>

where Data: TrivialType + Encode,

impl<Data> Eq for Unaligned<Data>

where Data: TrivialType + Eq + Copy,

impl<Data> StructuralPartialEq for Unaligned<Data>

where Data: TrivialType,