Struct flatten_json_object::Flattener

pub struct Flattener { /* private fields */ }

Basic struct of this crate. It contains the configuration. Instantiate it and use the method flatten to flatten a JSON object.

Implementations

impl Flattener

pub fn new() -> Self

Creates a JSON object flattener with the default configuration.

pub fn set_key_separator(self, key_separator: &str) -> Self

Changes the string used to separate keys in the resulting flattened object.

pub fn set_array_formatting(self, array_formatting: ArrayFormatting) -> Self

Changes the way arrays are formatted. By default the position in the array is treated as a normal key, but with this function we can change this behaviour.

pub fn set_preserve_empty_arrays(self, value: bool) -> Self

Changes the behaviour regarding empty arrays []

pub fn set_preserve_empty_objects(self, value: bool) -> Self

Changes the behaviour regarding empty objects {}

pub fn key_separator(&self) -> &str

pub fn array_formatting(&self) -> &ArrayFormatting

pub fn preserve_empty_arrays(&self) -> bool

pub fn preserve_empty_objects(&self) -> bool

pub fn flatten(&self, to_flatten: &Value) -> Result<Value, Error>

Flattens the provided JSON object (current).

It will return an error if flattening the object would make two keys to be the same, overwriting a value. It will alre return an error if the JSON value passed it’s not an object.

Errors

Will return Err if to_flatten it’s not an object, or if flattening the object would result in two or more keys colliding.

Trait Implementations

impl Clone for Flattener

fn clone(&self) -> Flattener

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Flattener

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

Formats the value using the given formatter.

impl Default for Flattener

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<Flattener> for Flattener

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for Flattener

impl StructuralEq for Flattener

impl StructuralPartialEq for Flattener