Struct LineFilter 

pub struct LineFilter<E> { /* private fields */ }

Writes only some lines of a table, with another exporter or format: for example a copy without group footers and the totals, or the application’s rows alone. It wraps any clipboard format, and a grid takes it as any exporter (LiveGridState::with_exporter); it wraps any file format, and an export takes it as any format.

use gpui_kit_grid::{CsvFormat, ExportLine, ExportLines, LineFilter, TsvExporter};

let exporter = LineFilter::new(
    TsvExporter,
    ExportLines::ALL
        .without(ExportLine::Footer)
        .without(ExportLine::Totals),
);
assert!(!exporter.lines().contains(ExportLine::Footer));

// The application's rows alone, to a CSV file.
let format = LineFilter::new(CsvFormat::new(), ExportLines::EMPTY.with(ExportLine::Data));

A table without a left-out line goes to the exporter as it is; otherwise the kept rows are copied into one list per export, in the background. A file format’s progress counts the left-out rows as written at the start.

Implementations

impl<E> LineFilter<E>

pub fn new(exporter: E, lines: ExportLines) -> Self

Writes the lines of a table with exporter.

pub fn exporter(&self) -> &E

The exporter that writes the kept lines.

pub fn lines(&self) -> ExportLines

The lines written.

Trait Implementations

impl<E: Clone> Clone for LineFilter<E>

fn clone(&self) -> LineFilter<E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Debug> Debug for LineFilter<E>

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

Formats the value using the given formatter.

impl<E: Default> Default for LineFilter<E>

fn default() -> LineFilter<E>

Returns the “default value” for a type.

impl<R: GridRow, E: ExportFormat<R>> ExportFormat<R> for LineFilter<E>

fn extension(&self) -> &str

The file name extension, without a dot: “csv”, “tsv”.

fn export( &self, table: &ExportTable<'_, R>, cells: &CellExport<R>, out: &mut dyn Write, control: &ExportControl, ) -> Result<(), ExportError>

Writes table to out; text cells with cells, as a text format does (a spreadsheet format reads ExportCell::value instead).

impl<R: GridRow, E: Exporter<R>> Exporter<R> for LineFilter<E>

fn export( &self, table: &ExportTable<'_, R>, cells: &CellExport<R>, out: &mut String, )

Appends the text of table to out, writing each cell with cells.

impl<E: Copy> Copy for LineFilter<E>