Struct clipivot::cli_settings::CsvSettings

pub struct CsvSettings { /* private fields */ }

The core struct of the settings module, providing general settings and utilities for writing CSV command-line tools.

Implementations

impl CsvSettings

pub fn parse_new( fname: &Option<&str>, delim: Option<&str>, has_header: bool ) -> CsvCliResult<CsvSettings>

Tries to create a new CSVSettings struct. Returns an error if it fails to parse the delimiter. (If this happens, it is likely because the delimiter must be a single UTF-8 byte.)

pub fn get_reader_from_path(&self, filename: &str) -> Result<Reader<File>>

Returns a csv::Reader object from a filepath, returning an error if the file doesn’t exist.

pub fn get_reader_from_stdin(&self) -> Reader<Stdin>

Returns a csv::Reader object from standard input.

pub fn get_field_index( &self, colname: &str, headers: &Vec<&str> ) -> CsvCliResult<usize>

Returns a single index where a single string appears. Allows you to validate a single column, rather than multiple columns.

pub fn get_field_indexes( &self, user_defs: &Vec<&str>, headers: &Vec<&str> ) -> CsvCliResult<Vec<usize>>

Given a vector of column descriptions, returns indexes where they appear You can see a more complete description on GitHub, but at a basic level, the idea of this function is to allow users to describe columns either by their names or by their indexes.

Trait Implementations

impl Debug for CsvSettings

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

Formats the value using the given formatter.

impl Default for CsvSettings

fn default() -> CsvSettings

Returns the “default value” for a type.

impl PartialEq<CsvSettings> for CsvSettings

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for CsvSettings