Struct Json2Csv

pub struct Json2Csv { /* private fields */ }

Basic struct of this crate. It contains the configuration.Instantiate it and use the method convert_from_array or convert_from_file to convert the JSON input into a CSV file.

Implementations

impl Json2Csv

pub fn new(flattener: Flattener) -> Self

Creates a JSON to CSV object with the flattening config provided.

pub fn convert_from_array( self, objects: &[Value], csv_writer: Writer<impl Write>, ) -> Result<(), Error>

Flattens each one of the objects in the array slice and transforms each of them into a CSV row.

The headers of the CSV are the union of all the keys that result from flattening the objects in the input.

Errors

Will return Err if objects does not contain actual JSON objects. It will also report an error if two objects have keys that should be different but end looking the same after flattening, and if writing the CSV fails.

pub fn convert_from_reader( self, reader: impl Read, csv_writer: Writer<impl Write>, ) -> Result<(), Error>

Flattens the JSON objects in the file, transforming each of them into a CSV row.

The headers of the CSV are the union of all the keys that result from flattening the objects in the input. The file must contain JSON objects one immediately after the other or separated by whitespace. Note that it uses a temporary file to store the flattened input, which is automatically deleted when lo longer necessary.

Errors

Will return Err if parsing the file fails or if the JSONs there are not objects. It will also report an error if two objects have keys that should be different but end looking the same after flattening, and if writing the CSV or to the temporary file fails.

Trait Implementations

impl Clone for Json2Csv

fn clone(&self) -> Json2Csv

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Json2Csv

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

Formats the value using the given formatter.

impl PartialEq for Json2Csv

fn eq(&self, other: &Json2Csv) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Json2Csv

impl StructuralPartialEq for Json2Csv