Struct EncodeOptions 

pub struct EncodeOptions {

    pub format: RecordFormat,
    pub codepage: Codepage,
    pub preferred_zoned_encoding: ZonedEncodingFormat,
    pub use_raw: bool,
    pub bwz_encode: bool,
    pub strict_mode: bool,
    pub max_errors: Option<u64>,
    pub threads: usize,
    pub coerce_numbers: bool,
    pub on_encode_unmappable: UnmappablePolicy,
    pub json_number_mode: JsonNumberMode,
    pub zoned_encoding_override: Option<ZonedEncodingFormat>,
    pub float_format: FloatFormat,
}

Options for encoding operations

Fields

format: RecordFormat

Record format

codepage: Codepage

Character encoding

preferred_zoned_encoding: ZonedEncodingFormat

Fallback zoned decimal encoding format when no override or metadata applies

use_raw: bool

Whether to use raw data when available

bwz_encode: bool

BLANK WHEN ZERO encoding policy

strict_mode: bool

Error handling mode

max_errors: Option<u64>

Maximum errors before stopping

threads: usize

Number of threads for parallel processing

coerce_numbers: bool

Whether to coerce non-string JSON numbers to strings before encoding

on_encode_unmappable: UnmappablePolicy

Policy for unmappable characters during encoding

json_number_mode: JsonNumberMode

JSON number representation mode (used when round-tripping)

zoned_encoding_override: Option<ZonedEncodingFormat>

Explicit zoned decimal encoding format override

When specified, forces all zoned decimal fields to use this encoding format, overriding any preserved format from decode operations. This provides the highest precedence in the format selection hierarchy:

1. Explicit override (this field)
2. Preserved format from decode metadata
3. EBCDIC default for mainframe compatibility

float_format: FloatFormat

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

Implementations

impl EncodeOptions

pub fn new() -> EncodeOptions

Create new encode options with default values

Returns options configured for:

• Fixed record format
• CP037 EBCDIC codepage
• Single-threaded processing
• BLANK WHEN ZERO disabled

Use the builder methods to customize:

Examples

use copybook_options::{EncodeOptions, Codepage, RecordFormat};

let opts = EncodeOptions::new()
    .with_codepage(Codepage::CP037)
    .with_format(RecordFormat::Fixed)
    .with_bwz_encode(true)
    .with_coerce_numbers(true)
    .with_threads(4);

assert_eq!(opts.threads, 4);
assert!(opts.bwz_encode);
assert!(opts.coerce_numbers);

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

Set the record format

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

Set the codepage

pub fn with_use_raw(self, use_raw: bool) -> EncodeOptions

Enable or disable raw data usage

pub fn with_bwz_encode(self, bwz_encode: bool) -> EncodeOptions

Enable or disable BLANK WHEN ZERO encoding

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

Set the preferred zoned encoding fallback when overrides and preserved formats are absent

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

Enable or disable strict mode

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

Set the maximum number of errors before stopping

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

Set the number of threads for parallel processing

pub fn with_coerce_numbers(self, coerce_numbers: bool) -> EncodeOptions

Enable or disable number coercion

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

Set the policy for unmappable characters during encoding

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

Set the JSON number mode

pub fn with_zoned_encoding_override( self, zoned_encoding_override: Option<ZonedEncodingFormat>, ) -> EncodeOptions

Set explicit zoned decimal encoding format override

Forces all zoned decimal fields to use the specified encoding format, overriding any preserved format from decode operations. Use None to disable override and respect preserved formats.

pub fn with_zoned_encoding_format( self, format: ZonedEncodingFormat, ) -> EncodeOptions

Convenience method to set explicit zoned encoding format

Equivalent to with_zoned_encoding_override(Some(format)).

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

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

Trait Implementations

impl Clone for EncodeOptions

fn clone(&self) -> EncodeOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EncodeOptions

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

Formats the value using the given formatter.

impl Default for EncodeOptions

fn default() -> EncodeOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EncodeOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EncodeOptions

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.