Struct DumpOptions 

pub struct DumpOptions {
    pub include_fields: HashSet<String>,
    pub exclude_fields: HashSet<String>,
    pub exclude_none: bool,
    pub indent: Option<usize>,
    pub recursive: bool,
}

Options for controlling serialization output.

Mirrors Pydantic’s model_dump() parameters.

Example

use rusdantic_core::dump::DumpOptions;

let opts = DumpOptions::new()
    .exclude(&["password", "secret"])
    .exclude_none(true);

Fields

include_fields: HashSet<String>

Only include these fields in the output (whitelist). If empty, all fields are included.

exclude_fields: HashSet<String>

Exclude these fields from the output (blacklist).

exclude_none: bool

If true, skip fields with None values.

indent: Option<usize>

Indentation for JSON output (None = compact).

recursive: bool

If true, apply include/exclude/exclude_none recursively to nested objects. Default: false (only filter top-level fields, matching Pydantic behavior).

Implementations

impl DumpOptions

pub fn new() -> Self

Create a new DumpOptions with default settings (include all, compact).

pub fn include(self, fields: &[&str]) -> Self

Only include the specified fields in the output.

pub fn exclude(self, fields: &[&str]) -> Self

Exclude the specified fields from the output.

pub fn exclude_none(self, yes: bool) -> Self

If true, skip fields with None / null values.

pub fn indent(self, spaces: usize) -> Self

Set JSON indentation (None = compact).

pub fn filter_value(&self, value: &mut Value)

Apply options to a serialized JSON Value, filtering fields.

By default, only top-level fields are filtered (matching Pydantic behavior). Set recursive(true) to also filter nested objects.

pub fn recursive(self, yes: bool) -> Self

Set whether filtering applies recursively to nested objects.

Trait Implementations

impl Clone for DumpOptions

fn clone(&self) -> DumpOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DumpOptions

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

Formats the value using the given formatter.

impl Default for DumpOptions

fn default() -> DumpOptions

Returns the “default value” for a type.