Struct BatchesFootprints

pub struct BatchesFootprints {
    pub first_page_pos: usize,
    pub footprints: Vec<BatchFootprint>,
}

The resource footprints of continuous subsets of messages.

For a set of messages xcms[0..n], each footprints[i] contains the footprint of the batch xcms[0..i], so as i increases footprints[i] contains the footprint of a bigger batch.

Fields

first_page_pos: usize

The position in the first available MQ page where the batch will start being appended.

The messages in the batch will be enqueued to the message queue. Since the message queue is organized in pages, the messages may be enqueued across multiple contiguous pages. The position where we start appending messages to the first available MQ page is of particular importance since it impacts the performance of the enqueuing operation. That’s because the first page has to be decoded first. This is not needed for the following pages.

footprints: Vec<BatchFootprint>

Implementations

impl BatchesFootprints

pub fn push(&mut self, msg: &[u8], new_page: bool)

Appends a batch footprint to the back of the collection.

The new footprint represents a batch that includes all the messages contained by the previous batches plus the provided msg. If new_page is true, we will consider that the provided msg is appended to a new message queue page. Otherwise, we consider that it is appended to the current page.

pub fn search_best_by<F>(&self, f: F) -> &BatchFootprint

where F: FnMut(&BatchFootprint) -> Ordering,

Gets the biggest batch for which the comparator function returns Ordering::Less.

Trait Implementations

impl Debug for BatchesFootprints

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

Formats the value using the given formatter.

impl Default for BatchesFootprints

fn default() -> BatchesFootprints

Returns the “default value” for a type.