Skip to main content

FilteringConfig

Struct FilteringConfig 

Source
#[non_exhaustive]
pub struct FilteringConfig { pub remove_empty_strings: bool, pub remove_nulls: bool, pub remove_empty_objects: bool, pub remove_empty_arrays: bool, }
Expand description

Configuration for filtering operations

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§remove_empty_strings: bool

Remove keys with empty string values

§remove_nulls: bool

Remove keys with null values. Checked as the last step of a value’s processing pipeline, after any configured value_replacement and auto_convert_types have both run – so a value that only becomes null through a replacement (e.g. replacing a sentinel with a recognized null token) or through type conversion is still caught. This ordering is applied consistently across .flatten(), .unflatten(), and .normal() mode, and applies identically to single-document and batch input. A root-level null (the entire document, not a nested key) is never removed, since there’s no parent key to omit it under.

§remove_empty_objects: bool

Remove keys with empty object values

§remove_empty_arrays: bool

Remove keys with empty array values

Implementations§

Source§

impl FilteringConfig

Source

pub fn new() -> Self

Create a new FilteringConfig with all filters disabled

Source

pub fn remove_empty_strings(self, enabled: bool) -> Self

Enable removal of empty strings

Source

pub fn remove_nulls(self, enabled: bool) -> Self

Enable removal of null values. See the field doc comment on FilteringConfig::remove_nulls for the ordering guarantee relative to value_replacement/auto_convert_types.

Source

pub fn remove_empty_objects(self, enabled: bool) -> Self

Enable removal of empty objects

Source

pub fn remove_empty_arrays(self, enabled: bool) -> Self

Enable removal of empty arrays

Source

pub fn has_any_filter(&self) -> bool

Check if any filtering is enabled

Trait Implementations§

Source§

impl Clone for FilteringConfig

Source§

fn clone(&self) -> FilteringConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FilteringConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FilteringConfig

Source§

fn default() -> FilteringConfig

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.