44 releases (28 major breaking)

55.1.0 May 13, 2025
54.3.1 Mar 30, 2025
54.0.0 Dec 23, 2024
53.4.1 Mar 7, 2025
27.0.0 Nov 14, 2022

#171 in Encoding

Download history 253006/week @ 2025-02-02 346218/week @ 2025-02-09 349753/week @ 2025-02-16 500636/week @ 2025-02-23 511975/week @ 2025-03-02 491134/week @ 2025-03-09 453389/week @ 2025-03-16 453980/week @ 2025-03-23 465141/week @ 2025-03-30 519783/week @ 2025-04-06 424705/week @ 2025-04-13 397682/week @ 2025-04-20 336521/week @ 2025-04-27 368457/week @ 2025-05-04 392362/week @ 2025-05-11 378129/week @ 2025-05-18

1,487,359 downloads per month
Used in 56 crates (20 directly)

Apache-2.0

3.5MB
65K SLoC

Transfer data between the Arrow memory format and JSON line-delimited records.

See the module level documentation for the reader and writer for usage examples.

Binary Data

As per RFC7159 JSON cannot encode arbitrary binary data. A common approach to workaround this is to use a binary-to-text encoding scheme, such as base64, to encode the input data and then decode it on output.

#
// The data we want to write
let input = BinaryArray::from(vec![b"\xDE\x00\xFF".as_ref()]);

// Base64 encode it to a string
let encoded: StringArray = b64_encode(&BASE64_STANDARD, &input);

// Write the StringArray to JSON
let batch = RecordBatch::try_from_iter([("col", Arc::new(encoded) as _)]).unwrap();
let mut buf = Vec::with_capacity(1024);
let mut writer = LineDelimitedWriter::new(&mut buf);
writer.write(&batch).unwrap();
writer.finish().unwrap();

// Read the JSON data
let cursor = Cursor::new(buf);
let mut reader = ReaderBuilder::new(batch.schema()).build(cursor).unwrap();
let batch = reader.next().unwrap().unwrap();

// Reverse the base64 encoding
let col: BinaryArray = batch.column(0).as_string::<i32>().clone().into();
let output = b64_decode(&BASE64_STANDARD, &col).unwrap();

assert_eq!(input, output);

Dependencies

~8.5MB
~149K SLoC