Struct MessageHeader

pub struct MessageHeader {
    pub channel: usize,
    pub source: usize,
    pub target_lower: usize,
    pub target_upper: 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_lower: usize

lower bound of index of worker receiving message.

target_upper: usize

upper bound of index of worker receiving message.

This is often self.target_lower + 1 for point to point messages, but can be larger for broadcast messages.

length: usize

number of bytes in message.

seqno: usize

sequence number.

Implementations

impl MessageHeader

pub fn try_read(bytes: &[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.

pub fn header_bytes(&self) -> usize

The number of bytes required for the header.

Trait Implementations

impl Clone for MessageHeader

fn clone(&self) -> MessageHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Columnar for MessageHeader

where usize: Columnar,

type Container = MessageHeaderContainer<<usize as Columnar>::Container, <usize as Columnar>::Container, <usize as Columnar>::Container, <usize as Columnar>::Container, <usize as Columnar>::Container, <usize as Columnar>::Container>

The type that stores the columnar representation.

fn copy_from<'a>( &mut self, other: <<MessageHeader as Columnar>::Container as Container>::Ref<'a>, )

Repopulates self from a reference.

fn into_owned<'a>( other: <<MessageHeader as Columnar>::Container as Container>::Ref<'a>, ) -> MessageHeader

Produce an instance of Self from Self::Ref<'a>.

fn as_columns<'a, I>(selves: I) -> Self::Container

where I: IntoIterator<Item = &'a Self>, Self: 'a,

Converts a sequence of the references to the type into columnar form.

fn into_columns<I>(selves: I) -> Self::Container

where I: IntoIterator<Item = Self>, Self: Sized,

Converts a sequence of the type into columnar form.

fn reborrow<'b, 'a>( thing: <Self::Container as Container>::Ref<'a>, ) -> <Self::Container as Container>::Ref<'b>

where 'a: 'b,

Reborrows the reference type to a shorter lifetime.

impl Debug for MessageHeader

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MessageHeader

fn deserialize<__D>( __deserializer: __D, ) -> Result<MessageHeader, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for MessageHeader

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

where __H: Hasher,

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<R0, R1, R2, R3, R4, R5> PartialEq<MessageHeader> for MessageHeaderReference<R0, R1, R2, R3, R4, R5>

where R0: PartialEq<usize>, R1: PartialEq<usize>, R2: PartialEq<usize>, R3: PartialEq<usize>, R4: PartialEq<usize>, R5: PartialEq<usize>,

fn eq(&self, other: &MessageHeader) -> 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 PartialEq for MessageHeader

fn eq(&self, other: &MessageHeader) -> 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<'columnar, C0, C1, C2, C3, C4, C5> Push<&'columnar MessageHeader> for MessageHeaderContainer<C0, C1, C2, C3, C4, C5>

where C0: Push<&'columnar usize>, C1: Push<&'columnar usize>, C2: Push<&'columnar usize>, C3: Push<&'columnar usize>, C4: Push<&'columnar usize>, C5: Push<&'columnar usize>,

fn push(&mut self, item: &'columnar MessageHeader)

Pushes an item onto self.

fn extend(&mut self, iter: impl IntoIterator<Item = T>)

Pushes elements of an iterator onto self.

impl<C0, C1, C2, C3, C4, C5> Push<MessageHeader> for MessageHeaderContainer<C0, C1, C2, C3, C4, C5>

where C0: Push<usize>, C1: Push<usize>, C2: Push<usize>, C3: Push<usize>, C4: Push<usize>, C5: Push<usize>,

fn push(&mut self, item: MessageHeader)

Pushes an item onto self.

fn extend(&mut self, iter: impl IntoIterator<Item = T>)

Pushes elements of an iterator onto self.

impl Serialize for MessageHeader

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for MessageHeader

impl Eq for MessageHeader

impl StructuralPartialEq for MessageHeader