Expand description
This csv-scout
crate provides methods to infer CSV file details (delimiter choice, quote
character, number of fields, field data types, etc.).
§Overview
The Sniffer
type is the primary entry point for using this crate. Its
Sniffer::open_path
and
Sniffer::open_reader
methods return a configured
csv::Reader
.
Alternatively, the Sniffer::sniff_path
and
Sniffer::sniff_reader
methods return a
Metadata
object containing the deduced details about the
underlying CSV input.
This sniffer detects the following metadata about a CSV file:
- Delimiter – byte character between fields in a record
- Quote – byte character (either “, ’, or `) used to quote fields, or that the file has no quotes
See Metadata
for full information about what the sniffer returns.
§Setup
Add this to your Cargo.toml
:
[dependencies]
csv-scout = "0.1"
§Example
This example shows how to write a simple command-line tool for discovering the metadata of a CSV file:
use std::env;
fn main() {
let args: Vec<String> = env::args().collect();
if args.len() != 2 {
eprintln!("Usage: {} <file>", args[0]);
::std::process::exit(1);
}
// sniff the path provided by the first argument
match csv_scout::Sniffer::new().sniff_path(&args[1]) {
Ok(metadata) => {
println!("{}", metadata);
},
Err(err) => {
eprintln!("ERROR: {}", err);
}
}
}
This example is provided as the primary binary for this crate. In the source directory, this can be run as:
$ cargo run -- tests/data/library-visitors.csv
Modules§
Structs§
- Sniffer
- A CSV sniffer.
Enums§
- Sample
Size - Argument used when calling
sample_size
onSniffer
.