5 releases (breaking)

0.5.0 Nov 22, 2023
0.4.0 Oct 31, 2022
0.3.0 Oct 30, 2022
0.2.0 Oct 29, 2022
0.1.0 Oct 28, 2022

#246 in Encoding

Download history 1232/week @ 2024-01-01 1330/week @ 2024-01-08 1026/week @ 2024-01-15 1220/week @ 2024-01-22 1884/week @ 2024-01-29 1475/week @ 2024-02-05 1462/week @ 2024-02-12 1060/week @ 2024-02-19 1544/week @ 2024-02-26 1840/week @ 2024-03-04 1862/week @ 2024-03-11 1903/week @ 2024-03-18 1719/week @ 2024-03-25 1290/week @ 2024-04-01 1873/week @ 2024-04-08 1584/week @ 2024-04-15

6,613 downloads per month
Used in 5 crates

MIT license

393 lines

Project Status: Active – The project has reached a stable, usable state and is being actively developed. CI Status codecov.io Minimum Supported Rust Version MIT License

GitHub | crates.io | Documentation | Issues | Changelog

JSON Lines (a.k.a. newline-delimited JSON) is a simple format for storing sequences of JSON values in which each value is serialized on a single line and terminated by a newline sequence. The serde-jsonlines crate provides functionality for reading & writing these documents (whether all at once or line by line) using serde's serialization & deserialization features.

Basic usage involves simply importing the BufReadExt or WriteExt extension trait and then using the json_lines() or write_json_lines() method on a BufRead or Write value to read or write a sequence of JSON Lines values. Convenience functions are also provided for the common case of reading or writing a JSON Lines file given as a filepath.

At a lower level, values can be read or written one at a time (which is useful if, say, different lines are different types) by wrapping a BufRead or Write value in a JsonLinesReader or JsonLinesWriter and then calling the wrapped structure's read() or write() method, respectively.

When the async feature is enabled, analogous types for working with JSON Lines asynchronously under tokio become available.


use serde::{Deserialize, Serialize};
use serde_jsonlines::{json_lines, write_json_lines};
use std::io::Result;

#[derive(Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct Structure {
    pub name: String,
    pub size: i32,
    pub on: bool,

fn main() -> Result<()> {
    let values = vec![
        Structure {
            name: "Foo Bar".into(),
            size: 42,
            on: true,
        Structure {
            name: "Quux".into(),
            size: 23,
            on: false,
        Structure {
            name: "Gnusto Cleesh".into(),
            size: 17,
            on: true,
    write_json_lines("example.jsonl", &values)?;
    let values2 = json_lines("example.jsonl")?.collect::<Result<Vec<Structure>>>()?;
    assert_eq!(values, values2);


~39K SLoC