Struct NdjsonConfig

pub struct NdjsonConfig { /* private fields */ }

Configuration for the NDJSON-parser which controls the behavior in various situations.

By default, the parser will attempt to parse every line, i.e. every segment between \n characters, even if it is empty. This will result in errors for empty lines.

You can construct a config by first calling NdjsonConfig::default and then using the builder-style associated functions to configure it. See the example below.

use ndjson_stream::config::{EmptyLineHandling, NdjsonConfig};

let config = NdjsonConfig::default()
    .with_empty_line_handling(EmptyLineHandling::IgnoreBlank)
    .with_parse_rest(true);

Implementations

impl NdjsonConfig

pub fn with_empty_line_handling( self, empty_line_handling: EmptyLineHandling, ) -> NdjsonConfig

Creates a new config from this config which has a different handling for lines that contain no JSON values. See EmptyLineHandling for more details.

Returns

A new config with all the same values as this one, except the empty-line-handling.

pub fn with_parse_rest(self, parse_rest: bool) -> NdjsonConfig

Creates a new config from this config which has the given configuration on whether to parse or ignore the rest, i.e. the part after the last newline character. If parse_rest is set to false, the rest will always be ignored, while true causes it to only be ignored if it is empty or considered empty by the handling configured in NdjsonConfig::with_empty_line_handling, which by default is only truly empty. Otherwise, the rest is parsed like an ordinary JSON record. By default, this is set to false.

Returns

A new config with all the same values as this one, except the parse-rest-flag.

Trait Implementations

impl Clone for NdjsonConfig

fn clone(&self) -> NdjsonConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NdjsonConfig

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

Formats the value using the given formatter.

impl Default for NdjsonConfig

fn default() -> NdjsonConfig

Returns the “default value” for a type.

impl Hash for NdjsonConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for NdjsonConfig

fn eq(&self, other: &NdjsonConfig) -> 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 Copy for NdjsonConfig

impl Eq for NdjsonConfig

impl StructuralPartialEq for NdjsonConfig