Struct Par2CreatorOptions 

pub struct Par2CreatorOptions {

    pub output: Option<PathBuf>,
    pub base_path: Option<PathBuf>,
    pub inputs: Vec<PathBuf>,
    pub block_sizing: BlockSizing,
    pub recovery_amount: RecoveryAmount,
    pub first_exponent: u32,
    pub volume_scheme: VolumeScheme,
    pub volume_count: Option<u32>,
    pub memory_limit: Option<usize>,
    pub forward_kernel: ForwardKernel,
    pub backend: CreationBackend,
    pub overwrite: bool,
    pub dry_run: bool,
    pub cancellation: CancellationToken,
    pub progress: Option<ProgressCallback>,
}

Inputs and safety controls for PAR2 creation.

inputs contains explicit files only. The creator resolves their names relative to base_path and never walks a directory or expands a file list.

Fields

output: Option<PathBuf>

Output path or stem. A .par2 suffix is added when absent.

base_path: Option<PathBuf>

Directory against which source names are made relative.

inputs: Vec<PathBuf>

Explicit source file paths.

block_sizing: BlockSizing

Source slice-size selection.

recovery_amount: RecoveryAmount

Recovery-slice selection.

first_exponent: u32

Exponent assigned to the first recovery slice.

volume_scheme: VolumeScheme

Recovery-volume allocation scheme.

volume_count: Option<u32>

Explicit recovery-volume count, or automatic when absent.

memory_limit: Option<usize>

Optional bounded forward-processing buffer budget in bytes.

forward_kernel: ForwardKernel

Arithmetic path requested for forward recovery encoding.

backend: CreationBackend

Backend policy requested for recovery-data creation.

overwrite: bool

Permit replacing existing output files after a successful staged write.

dry_run: bool

Suppress filesystem writes while retaining validation and planning.

cancellation: CancellationToken

Cooperative cancellation shared with the caller.

progress: Option<ProgressCallback>

Optional progress observer.

Implementations

impl Par2CreatorOptions

pub fn new(base_path: Option<PathBuf>, inputs: Vec<PathBuf>) -> Self

Construct options with the default creation policy.

pub fn with_output( output: PathBuf, base_path: Option<PathBuf>, inputs: Vec<PathBuf>, ) -> Self

Construct options with an output path and explicit source files.

pub fn set_output(&mut self, output: PathBuf)

Set the output path or stem.

Trait Implementations

impl Clone for Par2CreatorOptions

fn clone(&self) -> Par2CreatorOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Par2CreatorOptions

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

Formats the value using the given formatter.

impl Default for Par2CreatorOptions

fn default() -> Self

Returns the “default value” for a type.