Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/BurntSushi/rust-csv

A CSV parser for Rust, with Serde support.
https://github.com/BurntSushi/rust-csv

csv library rust rust-library

Last synced: 7 days ago
JSON representation

A CSV parser for Rust, with Serde support.

Awesome Lists containing this project

README 

        
csv

===

A fast and flexible CSV reader and writer for Rust, with support for Serde.



[![Build status](https://github.com/BurntSushi/rust-csv/workflows/ci/badge.svg)](https://github.com/BurntSushi/rust-csv/actions)

[![crates.io](https://img.shields.io/crates/v/csv.svg)](https://crates.io/crates/csv)



Dual-licensed under MIT or the [UNLICENSE](http://unlicense.org).



### Documentation



https://docs.rs/csv



If you're new to Rust, the

[tutorial](https://docs.rs/csv/1.*/csv/tutorial/index.html)

is a good place to start.



### Usage



To bring this crate into your repository, either add `csv` to your

`Cargo.toml`, or run `cargo add csv`.



### Example



This example shows how to read CSV data from stdin and print each record to

stdout.



There are more examples in the

[cookbook](https://docs.rs/csv/1.*/csv/cookbook/index.html).



```rust

use std::{error::Error, io, process};



fn example() -> Result<(), Box> {

    // Build the CSV reader and iterate over each record.

    let mut rdr = csv::Reader::from_reader(io::stdin());

    for result in rdr.records() {

        // The iterator yields Result, so we check the

        // error here.

        let record = result?;

        println!("{:?}", record);

    }

    Ok(())

}



fn main() {

    if let Err(err) = example() {

        println!("error running example: {}", err);

        process::exit(1);

    }

}

```



The above example can be run like so:



```text

$ git clone git://github.com/BurntSushi/rust-csv

$ cd rust-csv

$ cargo run --example cookbook-read-basic < examples/data/smallpop.csv

```



### Example with Serde



This example shows how to read CSV data from stdin into your own custom struct.

By default, the member names of the struct are matched with the values in the

header record of your CSV data.



```rust

use std::{error::Error, io, process};



#[derive(Debug, serde::Deserialize)]

struct Record {

    city: String,

    region: String,

    country: String,

    population: Option,

}



fn example() -> Result<(), Box> {

    let mut rdr = csv::Reader::from_reader(io::stdin());

    for result in rdr.deserialize() {

        // Notice that we need to provide a type hint for automatic

        // deserialization.

        let record: Record = result?;

        println!("{:?}", record);

    }

    Ok(())

}



fn main() {

    if let Err(err) = example() {

        println!("error running example: {}", err);

        process::exit(1);

    }

}

```



The above example can be run like so:



```

$ git clone git://github.com/BurntSushi/rust-csv

$ cd rust-csv

$ cargo run --example cookbook-read-serde < examples/data/smallpop.csv

```