Struct ratman_netmod::SeqBuilder

pub struct SeqBuilder { /* fields omitted */ }

Utility wrapping around Vec<Frame> with SeqId initialisation.

This type implements a builder, which is initialised with header data, then filled with various sliced payloads, and then made into a frame sequence, as outlined in the root netmod docs.

Implementations

impl SeqBuilder

pub fn new(sender: Identity, recp: Recipient, seqid: SeqId) -> Self

Initialise a Sequence builder

pub fn add(mut self: Self, data: Vec<u8>) -> Self

Add a slice of payload to the sequence set

pub fn build(self) -> Vec<Frame>

Consume the builder into a set of frames

pub fn restore(buf: &mut Vec<Frame>) -> Vec<u8>

Take a sequence of frames and turn it into a complete payload

This function assumes a complete set of frame that has previously been sorted along the seq.num metric.

pub fn seqid(&self) -> &SeqId

Read the sequence ID back from the builder

pub fn sender(&self) -> Identity

Read the sender back from the builder

pub fn recp(&self) -> Recipient

Read the recipient back from the builder

pub fn data(&self) -> Vec<u8>

Read the payload data set back from the builder