Struct de_net::tasks::communicator::builder::PackageBuilder

pub struct PackageBuilder {
    reliability: Reliability,
    peers: Peers,
    target: SocketAddr,
    buffer: Buffer,
    latest: Option<Instant>,
    packages: VecDeque<OutPackage>,
}

It cumulatively builds output packages from individual messages.

Fields

reliability: Reliability

peers: Peers

target: SocketAddr

buffer: Buffer

latest: Option<Instant>

packages: VecDeque<OutPackage>

Implementations

impl PackageBuilder

pub fn new(reliability: Reliability, peers: Peers, target: SocketAddr) -> Self

pub fn latest(&self) -> Option<Instant>

Time of newest message in the buffer.

pub fn build_old(&mut self, threshold: Instant) -> PackageIterator<'_>

Build packages from all messages pushed before a given threshold. The last yielded package may contain newer data.

See Self::build_all.

pub fn build_all(&mut self) -> PackageIterator<'_>

Build packages from all pushed messages.

The messages are distributed among the packages in a sequential order. Each package except the last one is filled with as many messages as it can accommodate.

pub fn push<E>(&mut self, message: &E, time: Instant) -> Result<(), EncodeError>

where E: Encode,

Push another message to the builder so that it is included in one of the resulting packages.

It is assumed that messages are pushed in the order of their time.

Arguments

• message - message to be pushed to the buffer.

• time - time of creation of the message.

fn push_inner<E>( &mut self, message: &E, time: Instant ) -> Result<(), EncodeError>

where E: Encode,

fn build_package(&mut self, empty: bool)

Build and store another package from already buffered data (if there is any).

Arguments

• empty - if true, newly created buffer for further messages will be empty.