Struct WriteReport 

#[non_exhaustive]
pub struct WriteReport {
    pub accepted: usize,
    pub coalesced: usize,
    pub skipped: usize,
}

What a sink did with a page it was offered, beyond the rows it wrote.

Returned by Sink::write_batch_reported. A sink that merges rows within a page (keyed upsert / delete, last write wins) reports the merged rows as coalesced, so the pipeline can tell them apart from rows it dropped.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

accepted: usize

Rows the sink wrote (what Sink::write_batch returns).

coalesced: usize

Rows merged into another row of the same page and therefore not written on their own.

skipped: usize

Rows the sink deliberately did not write, by design of its configuration (a preview cap, a declined record), and says so.

Implementations

impl WriteReport

pub fn accepted(accepted: usize) -> Self

A report of accepted written rows and nothing coalesced.

pub fn with_coalesced(self, coalesced: usize) -> Self

The same report with coalesced merged rows.

pub fn with_skipped(self, skipped: usize) -> Self

The same report with skipped rows the sink declined by design.

pub fn keyed(offered: usize, planned: usize) -> Self

For a sink that wrote planned rows out of offered after merging rows of the same key: planned accepted, the rest coalesced.

pub fn accounted(&self) -> usize

Rows the report accounts for.

pub fn check(&self, offered: usize) -> Result<(), FaucetError>

Ok when every one of offered rows is accounted for. A sink that reports more than it was offered (e.g. a database counting an update as two affected rows) is not a loss.

Trait Implementations

impl Clone for WriteReport

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for WriteReport

impl Debug for WriteReport

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

Formats the value using the given formatter.

impl Default for WriteReport

fn default() -> Self

Returns the “default value” for a type.

impl Eq for WriteReport

impl PartialEq for WriteReport

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for WriteReport