Struct Par2CreatePlan 

pub struct Par2CreatePlan {

    pub base_path: PathBuf,
    pub output_stem: PathBuf,
    pub main_path: PathBuf,
    pub volumes: Vec<RecoveryVolumePlan>,
    pub volume_scheme: VolumeScheme,
    pub volume_paths: Vec<PathBuf>,
    pub output_paths: Vec<PathBuf>,
    pub sources: Vec<CreationSource>,
    pub slice_size: u64,
    pub source_slice_count: u32,
    pub recovery_count: u32,
    pub first_exponent: RecoveryExponent,
    pub recovery_exponents: Vec<RecoveryExponent>,
    pub recovery_set_id: RecoverySetId,
    pub forward_kernel: ForwardKernel,
    pub backend: CreationBackend,
    pub memory: Par2MemoryPlan,
    pub dry_run: bool,
    pub skipped_empty: Vec<PathBuf>,
    /* private fields */
}

Fully validated creation inputs and deterministic output allocation.

Fields

base_path: PathBuf

Canonical base directory used for source resolution and packet names.

output_stem: PathBuf

Canonical output stem without the final par2 suffix.

main_path: PathBuf

Main critical-packet output path.

volumes: Vec<RecoveryVolumePlan>

Recovery volume allocations, in increasing exponent order.

volume_scheme: VolumeScheme

Recovery volume sizing policy used for the allocation.

volume_paths: Vec<PathBuf>

Recovery volume paths, matching the volume allocations.

output_paths: Vec<PathBuf>

All output paths, with the main file first.

sources: Vec<CreationSource>

Sources sorted by PAR2 file identifier, which is also encoder input order.

slice_size: u64

Source slice size in bytes.

source_slice_count: u32

Total number of source slices across all files.

recovery_count: u32

Number of recovery slices.

first_exponent: RecoveryExponent

Exponent assigned to the first recovery slice.

recovery_exponents: Vec<RecoveryExponent>

Recovery exponents in output order.

recovery_set_id: RecoverySetId

Recovery-set identifier from the Main packet body.

forward_kernel: ForwardKernel

Forward arithmetic path selected when this plan was built.

backend: CreationBackend

Creation backend policy requested for this plan.

memory: Par2MemoryPlan

Memory accounting for this plan.

dry_run: bool

Whether the caller requested a write-free operation.

skipped_empty: Vec<PathBuf>

Inputs excluded from the set because they are zero-length, in input order, as the caller spelled them.

A PAR2 set cannot describe an empty file (the format protects slices and an empty file has none), so these inputs are not in sources, get no packets, and are invisible to verify and repair. The reference encoder makes the same exclusion and reports it unconditionally (“Skipping 0 byte file”); callers that surface plans to a human should do the same with this list, because a set that silently protects fewer files than were listed reads as protection it does not provide.

Implementations

impl Par2CreatePlan

pub fn file_count(&self) -> usize

Return the number of critical source files in the set.

pub fn volume_count(&self) -> usize

Return the number of recovery volume files.

Trait Implementations

impl Clone for Par2CreatePlan

fn clone(&self) -> Par2CreatePlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Par2CreatePlan

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

Formats the value using the given formatter.

impl Eq for Par2CreatePlan

impl PartialEq for Par2CreatePlan

fn eq(&self, other: &Par2CreatePlan) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Par2CreatePlan