Struct Sniffer 

pub struct Sniffer { /* private fields */ }

A CSV sniffer.

The sniffer examines a CSV file, passed in either through a file or a reader.

Implementations

impl Sniffer

pub fn new() -> Self

Create a new CSV sniffer.

Examples found in repository

examples/sniff_gdp.rs (line 12)

fn main() {
    let data_filepath = Path::new(file!())
        .parent()
        .unwrap()
        .join("../tests/data/gdp.csv");
    let dialect = Sniffer::new()
        .sample_size(SampleSize::All)
        .sniff_path(data_filepath)
        .unwrap();
    println!("{dialect:#?}");
}

pub fn delimiter(&mut self, delimiter: u8) -> &mut Self

Specify the delimiter character.

pub fn quote(&mut self, quote: Quote) -> &mut Self

Specify the header type (whether the CSV file has a header row, and where the data starts). Specify the quote character (if any), and whether two quotes in a row as to be interpreted as an escaped quote.

pub fn sample_size(&mut self, sample_size: SampleSize) -> &mut Self

The size of the sample to examine while sniffing. If using SampleSize::Records, the sniffer will use the Terminator::CRLF as record separator.

The sample size defaults to SampleSize::Bytes(4096).

Examples found in repository

examples/sniff_gdp.rs (line 13)

fn main() {
    let data_filepath = Path::new(file!())
        .parent()
        .unwrap()
        .join("../tests/data/gdp.csv");
    let dialect = Sniffer::new()
        .sample_size(SampleSize::All)
        .sniff_path(data_filepath)
        .unwrap();
    println!("{dialect:#?}");
}

pub fn open_path<P: AsRef<Path>>(&mut self, path: P) -> Result<Reader<File>>

Sniff the CSV file located at the provided path, and return a Reader (from the csv crate) ready to ready the file.

Fails on file opening or rendering errors, or on an error examining the file.

pub fn open_reader<R: Read + Seek>(&mut self, reader: R) -> Result<Reader<R>>

Sniff the CSV file provided by the reader, and return a csv Reader object.

Fails on file opening or rendering errors, or on an error examining the file.

pub fn sniff_path<P: AsRef<Path>>(&mut self, path: P) -> Result<Metadata>

Sniff the CSV file located at the provided path, and return a Metadata object containing information about the CSV file.

Fails on file opening or rendering errors, or on an error examining the file.

Examples found in repository

examples/sniff_gdp.rs (line 14)

fn main() {
    let data_filepath = Path::new(file!())
        .parent()
        .unwrap()
        .join("../tests/data/gdp.csv");
    let dialect = Sniffer::new()
        .sample_size(SampleSize::All)
        .sniff_path(data_filepath)
        .unwrap();
    println!("{dialect:#?}");
}

pub fn sniff_reader<R: Read + Seek>(&mut self, reader: R) -> Result<Metadata>

Sniff the CSV file provider by the reader, and return a Metadata object containing information about the CSV file.

Fails on file opening or readering errors, or on an error examining the file.

Trait Implementations

impl Debug for Sniffer

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

Formats the value using the given formatter.

impl Default for Sniffer

fn default() -> Sniffer

Returns the “default value” for a type.