Struct ExportControl 

pub struct ExportControl { /* private fields */ }

The progress and cancellation of one export, shared between the job that writes it and the application that waits for it. Clones share them.

Implementations

impl ExportControl

pub fn new(rows_total: usize) -> Self

A control for an export of rows_total rows; the grid makes one per export, a test of a format makes its own.

pub fn rows_total(&self) -> usize

The rows of the table, summary and band rows included, the header line not. A grid’s export counts them ahead when it starts and exactly once its job has built the table.

pub fn rows_written(&self) -> usize

The rows written so far, as the format reported them.

pub fn advance(&self, rows: usize) -> Result<(), ExportError>

Records rows more rows written. Returns Err(ExportError::Cancelled) once the export is cancelled: the format stops and returns it. advance(0) only checks.

pub fn is_cancelled(&self) -> bool

Returns true if the export is cancelled.

pub fn cancel(&self)

Cancels the export: the next advance fails.

Trait Implementations

impl Clone for ExportControl

fn clone(&self) -> ExportControl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExportControl

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

Formats the value using the given formatter.