Struct ExportRequest 

pub struct ExportRequest<R: GridRow> { /* private fields */ }

What an export takes from the grid: the scope, the header line, the columns and how a text cell is written.

use gpui_kit_grid::{EmptyExport, ExportHeader, ExportRequest, ExportScope, GridRow};

/// The whole view, every group and tree row expanded, without a header
/// line; a file of the header line alone when there is nothing to export.
fn everything<R: GridRow>() -> ExportRequest<R> {
    ExportRequest::new(ExportScope::Expanded)
        .with_header(ExportHeader::None)
        .with_empty(EmptyExport::HeaderOnly)
}

Implementations

impl<R: GridRow> ExportRequest<R>

pub fn new(scope: ExportScope) -> Self

An export of scope with a header line, the visible columns in screen order and the grid’s CellExport (LiveGridState::with_cell_export).

pub fn with_header(self, header: ExportHeader) -> Self

Sets the header lines (default Titles, whatever the scope; a copy of the selection has none).

pub fn with_empty(self, empty: EmptyExport) -> Self

Sets what an export of an empty scope does (default EmptyExport::Nothing).

pub fn with_columns(self, columns: impl IntoIterator<Item = R::Column>) -> Self

Exports these columns in this order, hidden ones included; columns the schema does not hold are left out. By default: the visible columns in screen order; for ExportScope::Selection in a cell mode, the visible columns that hold a selected cell.

pub fn with_cell_export(self, cells: CellExport<R>) -> Self

Sets how a text format writes a cell (default: the grid’s).

pub fn scope(&self) -> ExportScope

The rows the export takes.

pub fn header(&self) -> ExportHeader

The header lines.

pub fn empty(&self) -> EmptyExport

What an export of an empty scope does.

Trait Implementations

impl<R: GridRow> Clone for ExportRequest<R>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R: GridRow> Default for ExportRequest<R>

fn default() -> Self

The visible lines: ExportScope::Visible.