lazycsv 0.2.0

Vectorized, lazy-decoding, zero-copy CSV parser.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

lazycsv
========

[![Crates.io](https://img.shields.io/crates/v/lazycsv.svg)](https://crates.io/crates/lazycsv)
[![Documentation](https://docs.rs/lazycsv/badge.svg)](https://docs.rs/lazycsv)
[![License](https://img.shields.io/crates/l/lazycsv.svg)](COPYRIGHT)

Vectorized, lazy-decoding, zero-copy CSV parser.

[Benchmarks](https://lazycsv.contentstech.com)

## Primary Focuses

- **Vectorized**: The parser utilizes SIMD operations, therefore is very performant.
- **Minimal hidden costs**: Every API doesn't bring any invisible overheads, and each operation only does what it needs to do.
- **Zero copy, zero allocation by default**: The parser doesn't allocate any memory during parsing and only performs allocation when dequoting each cell.
- **Lazy Decoding**: Input is not copied or unquoted until requested. This is useful when you only need to access a few cells in a large CSV file.
- **`#![no_std]` eligible**: The crate is `#![no_std]` compatible, and it can be used in systems without an allocator.

## Supported Features

`lazycsv` primarily supports a subset of [RFC 4180](https://datatracker.ietf.org/doc/html/rfc4180) with minor extensions.

### According to RFC 4180:

- No escape mechanisms other than quoting are supported.
- Padding cells with whitespace is not allowed.
- Using double quotes without quoting is not allowed.
- Quotes must always appear at the very beginning of a cell.

### Additional Restrictions:

- Only ASCII and UTF-8 encodings are supported.

### Additional Supports:

- Using LF (`\n`) instead of CRLF (`\r\n`) as the newline is permitted.
- Customizing the separator character is possible.

## Examples

```rust
use lazycsv::{Csv, CsvIterItem};

// Iterating over rows
let csv = Csv::new(b"a,b,c\n1,2,3");
for [first, second, third] in csv.into_rows() {
    println!(
        "{}, {}, {}",
        first.try_as_str()?,
        second.try_as_str()?,
        third.try_as_str()?,
    );
}

// Or if you want to avoid buffering:
let csv2 = Csv::new(b"a,b,c\n1,2,3");
for item in csv2 {
    if let CsvIterItem::Cell(cell) = item {
        println!("{}", cell.try_as_str()?);
    }
}
```

 

--------

*lazycsv* is primarily distributed under the terms of both the [Apache License
(Version 2.0)] and the [MIT license]. See [COPYRIGHT] for details.

[MIT license]: LICENSE-MIT
[Apache License (Version 2.0)]: LICENSE-APACHE
[COPYRIGHT]: COPYRIGHT