Struct timely::communication::networking::MessageHeader

pub struct MessageHeader {
    pub channel: usize,
    pub source: usize,
    pub target: usize,
    pub length: usize,
    pub seqno: usize,
}

Framing data for each Vec<u8> transmission, indicating a typed channel, the source and destination workers, and the length in bytes.

Fields

channel: usize

index of channel.

source: usize

index of worker sending message.

target: usize

index of worker receiving message.

length: usize

number of bytes in message.

seqno: usize

sequence number.

Implementations

impl MessageHeader

pub fn try_read(bytes: &mut [u8]) -> Option<MessageHeader>

Returns a header when there is enough supporting data

pub fn write_to<W>(&self, writer: &mut W) -> Result<(), Error> where
    W: Write, 

Writes the header as binary data.

pub fn required_bytes(&self) -> usize

The number of bytes required for the header and data.

Trait Implementations

impl Abomonation for MessageHeader

pub unsafe fn entomb<W>(&self, _write: &mut W) -> Result<(), Error> where
    W: Write, 

Write any additional information about &self beyond its binary representation.

pub fn extent(&self) -> usize

Reports the number of further bytes required to entomb self.

pub unsafe fn exhume(&'a mut self, bytes: &'b mut [u8]) -> Option<&'b mut [u8]>

Recover any information for &mut self not evident from its binary representation.

impl Clone for MessageHeader

pub fn clone(&self) -> MessageHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for MessageHeader

impl Debug for MessageHeader

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

Formats the value using the given formatter.

impl Eq for MessageHeader

impl Hash for MessageHeader

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<MessageHeader> for MessageHeader

pub fn eq(&self, other: &MessageHeader) -> bool

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

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

This method tests for !=.

impl StructuralEq for MessageHeader

impl StructuralPartialEq for MessageHeader