pub struct Aligned<T, ToSizeOfType>{
pub value: T,
/* private fields */
}
Expand description
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
- TheParcel
type that is to be transmittedToSizeOfType
The transmitted bytes will be aligned to a multiple ofsize_of::<ToSizeOfType>()
. For example, ifToSizeOfType = 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.
Implementations§
Trait Implementations§
Source§impl<T, ToSizeOfType> Ord for Aligned<T, ToSizeOfType>
impl<T, ToSizeOfType> Ord for Aligned<T, ToSizeOfType>
1.21.0 · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read more
Source§impl<T, ToSizeOfType> Parcel for Aligned<T, ToSizeOfType>
impl<T, ToSizeOfType> Parcel for Aligned<T, ToSizeOfType>
Source§fn read_field(
read: &mut dyn Read,
settings: &Settings,
hints: &mut Hints,
) -> Result<Self, Error>
fn read_field( read: &mut dyn Read, settings: &Settings, hints: &mut Hints, ) -> Result<Self, Error>
Reads a value from a stream. Read more
Source§fn write_field(
&self,
write: &mut dyn Write,
settings: &Settings,
hints: &mut Hints,
) -> Result<(), Error>
fn write_field( &self, write: &mut dyn Write, settings: &Settings, hints: &mut Hints, ) -> Result<(), Error>
Writes a value to a stream.
Source§fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>
fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>
Reads a new item with a fresh set of hints. Read more
Source§fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>
fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>
Writes a value to a stream.
Source§fn into_stream(self, settings: &Settings) -> Result<Cursor<Vec<u8>>, Error>
fn into_stream(self, settings: &Settings) -> Result<Cursor<Vec<u8>>, Error>
Convers the value into a byte stream that implements
std::io::Read
.Source§fn from_raw_bytes(bytes: &[u8], settings: &Settings) -> Result<Self, Error>
fn from_raw_bytes(bytes: &[u8], settings: &Settings) -> Result<Self, Error>
Parses a new value from its raw byte representation. Read more
Source§fn field_from_raw_bytes(
bytes: &[u8],
settings: &Settings,
hints: &mut Hints,
) -> Result<Self, Error>
fn field_from_raw_bytes( bytes: &[u8], settings: &Settings, hints: &mut Hints, ) -> Result<Self, Error>
Parses a new value from its raw byte representation. Read more
Source§fn raw_bytes(&self, settings: &Settings) -> Result<Vec<u8>, Error>
fn raw_bytes(&self, settings: &Settings) -> Result<Vec<u8>, Error>
Gets the raw byte representation of the value.
Source§impl<T, ToSizeOfType> PartialOrd for Aligned<T, ToSizeOfType>
impl<T, ToSizeOfType> PartialOrd for Aligned<T, ToSizeOfType>
impl<T, ToSizeOfType> Copy for Aligned<T, ToSizeOfType>
impl<T, ToSizeOfType> Eq for Aligned<T, ToSizeOfType>
impl<T, ToSizeOfType> StructuralPartialEq for Aligned<T, ToSizeOfType>
Auto Trait Implementations§
impl<T, ToSizeOfType> Freeze for Aligned<T, ToSizeOfType>where
T: Freeze,
impl<T, ToSizeOfType> RefUnwindSafe for Aligned<T, ToSizeOfType>where
T: RefUnwindSafe,
ToSizeOfType: RefUnwindSafe,
impl<T, ToSizeOfType> Send for Aligned<T, ToSizeOfType>
impl<T, ToSizeOfType> Sync for Aligned<T, ToSizeOfType>
impl<T, ToSizeOfType> Unpin for Aligned<T, ToSizeOfType>
impl<T, ToSizeOfType> UnwindSafe for Aligned<T, ToSizeOfType>where
T: UnwindSafe,
ToSizeOfType: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more