Struct Reader

pub struct Reader<const N: usize> { /* private fields */ }

Wrapper for csv_core::Reader that provides methods for deserialization using serde.

N is a capacity of an internal buffer that’s used to temporarily store unescaped fields.

Implementations

impl<const N: usize> Reader<N>

pub fn new() -> Self

Constructs a new reader.

pub fn from_builder(builder: impl Borrow<ReaderBuilder>) -> Self

Constructs a new reader from csv_core::ReaderBuilder.

Example

use serde_csv_core::csv_core;

let reader = serde_csv_core::Reader::<16>::from_builder(
    csv_core::ReaderBuilder::new()
        .delimiter(b'-')
);

pub fn deserialize<'de, T>(&mut self, input: &[u8]) -> Result<(T, usize)>

where T: Deserialize<'de>,

Deserializes a given CSV byte slice into a value of type T.

The second element of the resulting tuple is a number of bytes read.

Example

use heapless::String;
use serde::Deserialize;

#[derive(Debug, PartialEq, Eq, Deserialize)]
struct Record {
    pub country: String<32>,
    pub city: String<32>,
    pub population: u32,
}

let csv = b"Poland,Cracow,766683\n";

let mut reader = serde_csv_core::Reader::<32>::new();
let (record, nread)  = reader.deserialize::<Record>(&csv[..])?;

assert_eq!(record, Record {
    country: "Poland".into(),
    city: "Cracow".into(),
    population: 766_683,
});
assert_eq!(nread, 21);

Trait Implementations

impl<const N: usize> Debug for Reader<N>

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

Formats the value using the given formatter.

impl<const N: usize> Default for Reader<N>

fn default() -> Self

Returns the “default value” for a type.