Struct OooBuffer 

pub struct OooBuffer<L, E>
where
    L: LogId,
    E: Extensions,
{ /* private fields */ }

Available on crate feature ingest only.

Out-of-order (ooo) buffer allowing a configurable window for handling operations with no predecessors yet.

For every operation this buffer checks if it arrived out-of-order. If yes, it is stored in the internal ring-buffer. If the buffer runs full the oldest item gets evicted first.

Example

If a log is at log height [1] (frontier) and an operation of sequence number [3] arrives, it can not be appended to the log due to the strict nature of an append-only log. It will be pushed into the buffer, awaiting the missing [2] operation:

         [0] <- [1] <- Log in database

[3] <- Incoming operation

=> Push into ooo-Buffer.

Operation [2] arrives which will “free” the out-of-order items in the buffer, making them “in order”. It will release them from the buffer and forward to the user for further validation and finally insertion into the database:

         [0] <- [1] <- Log in database

         [3] <- Operation in ooo-Buffer

[2] <- Incoming operation

=> Return [2, 3]

Assumptions

Please make sure to only process items which have been checked before against:

1. Incoming operations from tombstoned logs / topics were filtered out before.
2. Duplicate, already ingested operations have been filtered out before.

Implementations

impl<L, E> OooBuffer<L, E>

where L: LogId, E: Extensions,

pub fn new() -> OooBuffer<L, E>

pub fn with_capacity(capacity: usize) -> OooBuffer<L, E>

pub async fn len(&self) -> usize

pub async fn is_empty(&self) -> bool

pub async fn clear(&self)

pub async fn process<'a>( &self, operation: &'a Operation<E>, latest_header: Option<&AnyHeader>, log_id: &L, prune_flag: bool, ) -> OooResult<'a, E>

Trait Implementations

impl<L, E> Clone for OooBuffer<L, E>

where L: Clone + LogId, E: Clone + Extensions,

fn clone(&self) -> OooBuffer<L, E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<L, E> Debug for OooBuffer<L, E>

where L: Debug + LogId, E: Debug + Extensions,

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

Formats the value using the given formatter.

impl<L, E> Default for OooBuffer<L, E>

where L: LogId, E: Extensions,

fn default() -> OooBuffer<L, E>

Returns the “default value” for a type.