Struct protocol::logic::Aligned [−][src]
pub struct Aligned<T, ToSizeOfType> where
T: Parcel,
ToSizeOfType: Sized, {
pub value: T,
// some fields omitted
}
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
Gets the number of bytes of the alignment.
Trait Implementations
Reads a value from a stream. Read more
Writes a value to a stream.
Reads a new item with a fresh set of hints. Read more
Writes a value to a stream.
Convers the value into a byte stream that implements std::io::Read
.
Parses a new value from its raw byte representation. Read more
Parses a new value from its raw byte representation. Read more
Gets the raw byte representation of the value.
Gets the raw bytes of this type as a field of a larger type.
impl<T: PartialOrd, ToSizeOfType: PartialOrd> PartialOrd<Aligned<T, ToSizeOfType>> 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,
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
impl<T: Copy, ToSizeOfType: Copy> Copy for Aligned<T, ToSizeOfType> where
T: Parcel,
ToSizeOfType: Sized,
impl<T, ToSizeOfType> StructuralEq for Aligned<T, ToSizeOfType> where
T: Parcel,
ToSizeOfType: Sized,
impl<T, ToSizeOfType> StructuralPartialEq for Aligned<T, ToSizeOfType> where
T: Parcel,
ToSizeOfType: Sized,
Auto Trait Implementations
impl<T, ToSizeOfType> RefUnwindSafe for Aligned<T, ToSizeOfType> where
T: RefUnwindSafe,
ToSizeOfType: RefUnwindSafe,
impl<T, ToSizeOfType> UnwindSafe for Aligned<T, ToSizeOfType> where
T: UnwindSafe,
ToSizeOfType: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more