Struct DumpOptions 

pub struct DumpOptions {
    pub mode: DumpMode,
    pub include: Option<HashSet<String>>,
    pub exclude: Option<HashSet<String>>,
    pub by_alias: bool,
    pub exclude_unset: bool,
    pub exclude_defaults: bool,
    pub exclude_none: bool,
    pub exclude_computed_fields: bool,
    pub round_trip: bool,
    pub indent: Option<usize>,
}

Options for model_dump() and model_dump_json().

Controls the serialization behavior.

Fields

mode: DumpMode

Output mode: Json or Python (Rust native).

In Python/Pydantic, mode='json' produces JSON-compatible values while mode='python' preserves native Python types (e.g., datetime objects).

In this crate, model_dump()/sql_model_dump() return serde_json::Value, so both modes currently produce equivalent JSON-value output.

include: Option<HashSet<String>>

Only include these fields (if Some)

exclude: Option<HashSet<String>>

Exclude these fields

by_alias: bool

Use field aliases in output.

When true, sql_model_dump() will rename fields to their serialization_alias (or alias as fallback) in the output.

exclude_unset: bool

Exclude fields that were not explicitly set.

In Pydantic, this depends on tracking which fields were explicitly provided at construction time (distinct from exclude_defaults).

Rust structs do not retain “field set” metadata by default, so this option is rejected at runtime to avoid silently producing incorrect output.

Pydantic semantics: If a field has a default value and the user explicitly sets it to that default, it should still be included (it was “set”). With exclude_defaults, it would be excluded regardless of whether it was explicitly provided.

exclude_defaults: bool

Exclude fields with default values

exclude_none: bool

Exclude fields with None/null values

exclude_computed_fields: bool

Exclude computed fields (for future computed_field support)

round_trip: bool

Enable round-trip mode (preserves types for re-parsing).

Pydantic can alter serialization to ensure a dump can be fed back into validation and reproduce the same model. This crate does not yet implement tagged round-trip encoding, so this flag is currently accepted as a no-op.

indent: Option<usize>

Indentation for JSON output (None = compact, Some(n) = n spaces)

Implementations

impl DumpOptions

pub fn new() -> Self

Create new default options.

pub fn json(self) -> Self

Set output mode to JSON.

pub fn python(self) -> Self

Set output mode to Python (Rust native).

pub fn include( self, fields: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Set fields to include.

pub fn exclude( self, fields: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Set fields to exclude.

pub fn by_alias(self) -> Self

Enable by_alias mode.

pub fn exclude_unset(self) -> Self

Enable exclude_unset mode.

pub fn exclude_defaults(self) -> Self

Enable exclude_defaults mode.

pub fn exclude_none(self) -> Self

Enable exclude_none mode.

pub fn exclude_computed_fields(self) -> Self

Enable exclude_computed_fields mode.

pub fn round_trip(self) -> Self

Enable round_trip mode.

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

Set indentation for JSON output.

When set, JSON output will be pretty-printed with the specified number of spaces for indentation. When None (default), JSON is compact.

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.