Struct DecodeOptions 

pub struct DecodeOptions {

    pub format: RecordFormat,
    pub codepage: Codepage,
    pub json_number_mode: JsonNumberMode,
    pub emit_filler: bool,
    pub emit_meta: bool,
    pub emit_raw: RawMode,
    pub strict_mode: bool,
    pub max_errors: Option<u64>,
    pub on_decode_unmappable: UnmappablePolicy,
    pub threads: usize,
    pub preserve_zoned_encoding: bool,
    pub preferred_zoned_encoding: ZonedEncodingFormat,
    pub float_format: FloatFormat,
}

Options for decoding operations

Fields

format: RecordFormat

Record format

codepage: Codepage

Character encoding

json_number_mode: JsonNumberMode

JSON number representation

emit_filler: bool

Whether to emit FILLER fields

emit_meta: bool

Whether to emit metadata

emit_raw: RawMode

Raw data capture mode

strict_mode: bool

Error handling mode

max_errors: Option<u64>

Maximum errors before stopping

on_decode_unmappable: UnmappablePolicy

Policy for unmappable characters

threads: usize

Number of threads for parallel processing

preserve_zoned_encoding: bool

Enable zoned decimal encoding preservation for binary round-trip consistency

When enabled, the decoder captures the original encoding format (ASCII vs EBCDIC) and includes it in metadata for use during re-encoding to maintain byte-level fidelity in encode/decode cycles.

preferred_zoned_encoding: ZonedEncodingFormat

Preferred encoding format when auto-detection is ambiguous

Used as fallback when ZonedEncodingFormat::Auto cannot determine the format from the data (e.g., all-zero fields, mixed encodings).

float_format: FloatFormat

Floating-point representation for COMP-1/COMP-2 fields.

Implementations

impl DecodeOptions

pub fn new() -> DecodeOptions

Create new decode options with default values

Returns options configured for:

• Fixed record format
• CP037 EBCDIC codepage
• Lossless JSON number mode
• Single-threaded processing

Use the builder methods to customize:

Examples

use copybook_options::{DecodeOptions, Codepage, JsonNumberMode, RecordFormat, RawMode};

let opts = DecodeOptions::new()
    .with_codepage(Codepage::CP037)
    .with_format(RecordFormat::Fixed)
    .with_json_number_mode(JsonNumberMode::Lossless)
    .with_emit_meta(true)
    .with_threads(4);

assert_eq!(opts.threads, 4);
assert!(opts.emit_meta);

pub fn with_format(self, format: RecordFormat) -> DecodeOptions

Set the record format

pub fn with_codepage(self, codepage: Codepage) -> DecodeOptions

Set the codepage

pub fn with_json_number_mode(self, mode: JsonNumberMode) -> DecodeOptions

Set the JSON number mode

pub fn with_emit_filler(self, emit_filler: bool) -> DecodeOptions

Enable or disable FILLER field emission

pub fn with_emit_meta(self, emit_meta: bool) -> DecodeOptions

Enable or disable metadata emission

pub fn with_emit_raw(self, emit_raw: RawMode) -> DecodeOptions

Set the raw data capture mode

Controls whether and how raw binary data is included in decode output:

• RawMode::Off — no raw data (default)
• RawMode::Record — record payload in __raw_b64
• RawMode::RecordRDW — RDW header + payload in __raw_b64
• RawMode::Field — per-field raw values in <FIELD>__raw_b64

pub fn with_strict_mode(self, strict_mode: bool) -> DecodeOptions

Enable or disable strict mode

pub fn with_max_errors(self, max_errors: Option<u64>) -> DecodeOptions

Set the maximum number of errors before stopping

pub fn with_unmappable_policy(self, policy: UnmappablePolicy) -> DecodeOptions

Set the policy for unmappable characters

pub fn with_threads(self, threads: usize) -> DecodeOptions

Set the number of threads for parallel processing

pub fn with_preserve_zoned_encoding( self, preserve_zoned_encoding: bool, ) -> DecodeOptions

Enable zoned decimal encoding preservation for round-trip fidelity

When enabled, the decoder will detect and preserve the original encoding format (ASCII vs EBCDIC) for use during subsequent encoding operations. This ensures byte-level consistency in encode/decode cycles.

pub fn with_preferred_zoned_encoding( self, preferred_zoned_encoding: ZonedEncodingFormat, ) -> DecodeOptions

Set the preferred zoned encoding format for ambiguous detection

This format is used as a fallback when auto-detection cannot determine the encoding from the data (e.g., all-zero fields, mixed encodings).

pub fn with_float_format(self, float_format: FloatFormat) -> DecodeOptions

Set floating-point representation for COMP-1/COMP-2 fields

Trait Implementations

impl Clone for DecodeOptions

fn clone(&self) -> DecodeOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DecodeOptions

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

Formats the value using the given formatter.

impl Default for DecodeOptions

fn default() -> DecodeOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DecodeOptions

fn deserialize<__D>( __deserializer: __D, ) -> Result<DecodeOptions, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DecodeOptions

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.