Struct DeserializeOptions

#[non_exhaustive]
pub struct DeserializeOptions {
    pub deny_unsupported_types: bool,
    pub deny_recursive_tables: bool,
    pub sort_keys: bool,
    pub encode_empty_tables_as_array: bool,
}

Available on crate feature serialize only.

A struct with options to change default deserializer behavior.

Fields (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.

deny_unsupported_types: bool

If true, an attempt to serialize types such as Function, Thread, LightUserData and Error will cause an error. Otherwise these types skipped when iterating or serialized as unit type.

Default: true

deny_recursive_tables: bool

If true, an attempt to serialize a recursive table (table that refers to itself) will cause an error. Otherwise subsequent attempts to serialize the same table will be ignored.

Default: true

sort_keys: bool

If true, keys in tables will be iterated in sorted order.

Default: false

encode_empty_tables_as_array: bool

If true, empty Lua tables will be encoded as array, instead of map.

Default: false

Implementations

impl Options

pub const fn new() -> Self

Returns a new instance of Options with default parameters.

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

Sets deny_unsupported_types option.

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

Sets deny_recursive_tables option.

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

Sets sort_keys option.

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

Sets encode_empty_tables_as_array option.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.

impl Copy for Options