Struct CsvFormat 

pub struct CsvFormat { /* private fields */ }

Comma-separated values as RFC 4180 has them: fields separated by ,, every line ended by CRLF, a field in quotes when it holds the separator, a quote, CR or LF, inner quotes doubled. Leading and trailing spaces are kept without quotes.

Cells are written by the export’s CellExport: raw values by default (numbers with a ., TRUE and FALSE). A summary row is a line like any other and a cell the row does not export is an empty field, as in TsvExporter. The header line holds the column titles; header bands are not written.

The text is UTF-8 with a byte order mark by default, which Excel needs to read it as UTF-8 (CsvEncoding). A spreadsheet whose decimal separator is a comma reads ; between fields:

use gpui_kit_grid::{CellExport, CsvEncoding, CsvFormat, GridRow, RawCells};

let format = CsvFormat::new().with_separator(';');
assert_eq!(format.encoding(), CsvEncoding::Utf8WithBom);

// The cells to export with it: `1234,5`.
fn decimal_comma<R: GridRow>() -> CellExport<R> {
    CellExport::Raw(RawCells::new().with_decimal_separator(','))
}

No protection against formulas: a field that starts with =, +, - or @ is written as it is (-5 is a number). An application that exports text its users typed adds a ' with its own CellExport::Custom.

Implementations

impl CsvFormat

pub const fn new() -> Self

, between fields, CRLF after lines, UTF-8 with a byte order mark.

pub const fn with_separator(self, separator: char) -> Self

Separates fields with separator: ; for a spreadsheet whose decimal separator is a comma, with RawCells::with_decimal_separator(',').

Panics

If separator is a quote, CR or LF, which no reader tells apart.

pub const fn separator(&self) -> char

The separator between fields.

pub const fn with_encoding(self, encoding: CsvEncoding) -> Self

Encodes the text with encoding.

pub const fn encoding(&self) -> CsvEncoding

How the text is encoded.

Trait Implementations

impl Clone for CsvFormat

fn clone(&self) -> CsvFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CsvFormat

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

Formats the value using the given formatter.

impl Default for CsvFormat

fn default() -> Self

Returns the “default value” for a type.

impl<R: GridRow> ExportFormat<R> for CsvFormat

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 PartialEq for CsvFormat

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for CsvFormat

impl Eq for CsvFormat

impl StructuralPartialEq for CsvFormat