Struct protocol::logic::Aligned

pub struct Aligned<T, ToSizeOfType> where
    T: Parcel,
    ToSizeOfType: Sized,  {
    pub value: T,
    // some fields omitted
}

A value that is aligned to a specified number of bytes.

When bytes are written, they are zero-padding at the end until the total size is the smallest multiple of the size of ToSizeOfType.

When an Aligned type is read, a value of the inner T is first read, and then the minimum number of zero bytes in order to maintain alignment are read and ignored.

Type parameters:

• T - The Parcel type that is to be transmitted
• ToSizeOfType The transmitted bytes will be aligned to a multiple of size_of::<ToSizeOfType>(). For example, if ToSizeOfType = u32, then the written bytes will be aligned to a multiple of 4 bytes.

Examples:

extern crate protocol;
#[macro_use] extern crate protocol_derive;
use protocol::Parcel;

/// An example packet with a length prefix disjoint
/// from its data, with the data also
#[derive(Protocol, Clone, Debug, PartialEq)]
struct Packet {
    /// The length of the 'reason' string.
    pub reason_length: u8,
    /// The version number of the protocol.
    pub version_number: (u32, u32),
    #[protocol(length_prefix(bytes(reason_length)))]
    pub reason: protocol::logic::Aligned<String, u64>,

}

let raw_bytes = Packet {
    reason_length: 12,
    version_number: (11, 0xdeadbeef),
    reason: "hello world!".to_owned().into(),
}.raw_bytes(&protocol::Settings::default()).unwrap();

assert_eq!(&[
    12, // reason length
    0, 0, 0, 11, 0xde, 0xad, 0xbe, 0xef, // version number
    // the string "hello world".
    b'h', b'e', b'l', b'l', b'o', b' ', b'w', b'o', b'r', b'l', b'd', b'!',
    0x00, 0x00, 0x00, 0x00, // padding bytes to align to string to 16 bytes.
    ], &raw_bytes[..]);

Fields

value: T

The inner value.

Methods

impl<T, ToSizeOfType> Aligned<T, ToSizeOfType> where
    T: Parcel,
    ToSizeOfType: Sized, 

pub fn new(value: T) -> Self

Creates a new aligned value.

pub fn align_to_bytes() -> usize

Gets the number of bytes of the alignment.

Trait Implementations

impl<T, ToSizeOfType> Parcel for Aligned<T, ToSizeOfType> where
    T: Parcel,
    ToSizeOfType: Sized, 

const TYPE_NAME: &'static str

The textual name of the type.

fn read_field(
    read: &mut dyn Read,
    settings: &Settings,
    hints: &mut Hints
) -> Result<Self, Error>

Reads a value from a stream.

fn write_field(
    &self,
    write: &mut dyn Write,
    settings: &Settings,
    hints: &mut Hints
) -> Result<(), Error>

Writes a value to a stream.

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

Reads a new item with a fresh set of hints.

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

Writes a value to a stream.

fn into_stream(self, settings: &Settings) -> Result<Cursor<Vec<u8>>, Error>

Convers the value into a byte stream that implements std::io::Read.

fn from_raw_bytes(bytes: &[u8], settings: &Settings) -> Result<Self, Error>

Parses a new value from its raw byte representation.

fn field_from_raw_bytes(
    bytes: &[u8],
    settings: &Settings,
    hints: &mut Hints
) -> Result<Self, Error>

Parses a new value from its raw byte representation.

fn raw_bytes(&self, settings: &Settings) -> Result<Vec<u8>, Error>

Gets the raw byte representation of the value.

fn raw_bytes_field(
    &self,
    settings: &Settings,
    hints: &mut Hints
) -> Result<Vec<u8>, Error>

Gets the raw bytes of this type as a field of a larger type.

fn type_name(&self) -> &'static str

Gets the name of the type; Parcel::TYPE_NAME.

impl<T: Clone, ToSizeOfType: Clone> Clone for Aligned<T, ToSizeOfType> where
    T: Parcel,
    ToSizeOfType: Sized, 

fn clone(&self) -> Aligned<T, ToSizeOfType>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Ord, ToSizeOfType: Ord> Ord for Aligned<T, ToSizeOfType> where
    T: Parcel,
    ToSizeOfType: Sized, 

fn cmp(&self, other: &Aligned<T, ToSizeOfType>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T, ToSizeOfType> From<T> for Aligned<T, ToSizeOfType> where
    T: Parcel,
    ToSizeOfType: Sized, 

fn from(value: T) -> Self

Performs the conversion.

impl<T: Eq, ToSizeOfType: Eq> Eq for Aligned<T, ToSizeOfType> where
    T: Parcel,
    ToSizeOfType: Sized, 

impl<T: Copy, ToSizeOfType: Copy> Copy for Aligned<T, ToSizeOfType> where
    T: Parcel,
    ToSizeOfType: Sized, 

impl<T: PartialOrd, ToSizeOfType: PartialOrd> PartialOrd<Aligned<T, ToSizeOfType>> for Aligned<T, ToSizeOfType> where
    T: Parcel,
    ToSizeOfType: Sized, 

fn partial_cmp(&self, other: &Aligned<T, ToSizeOfType>) -> Option<Ordering>

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

fn lt(&self, other: &Aligned<T, ToSizeOfType>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Aligned<T, ToSizeOfType>) -> bool

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

fn gt(&self, other: &Aligned<T, ToSizeOfType>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Aligned<T, ToSizeOfType>) -> bool

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

impl<T: PartialEq, ToSizeOfType: PartialEq> PartialEq<Aligned<T, ToSizeOfType>> for Aligned<T, ToSizeOfType> where
    T: Parcel,
    ToSizeOfType: Sized, 

fn eq(&self, other: &Aligned<T, ToSizeOfType>) -> bool

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

fn ne(&self, other: &Aligned<T, ToSizeOfType>) -> bool

This method tests for !=.

impl<T: Debug, ToSizeOfType: Debug> Debug for Aligned<T, ToSizeOfType> where
    T: Parcel,
    ToSizeOfType: Sized, 

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

Formats the value using the given formatter.

impl<T: Hash, ToSizeOfType: Hash> Hash for Aligned<T, ToSizeOfType> where
    T: Parcel,
    ToSizeOfType: Sized, 

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].