Struct ApplyReport 

#[non_exhaustive]
pub struct ApplyReport {
    pub modified: usize,
    pub actual_steps: i32,
    pub clipping_prevented: bool,
    pub clipping_detected: Option<ClippingDetection>,
    pub saturated_low: usize,
    pub saturated_high: usize,
    pub gain_range: Option<(u8, u8)>,
}

Outcome of an apply_with_options call.

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.

modified: usize

MP3 frames or AAC gain fields actually modified.

actual_steps: i32

Steps actually applied (= ApplyOptions::steps unless ApplyOptions::prevent_clipping capped it, or unless steps==0).

clipping_prevented: bool

True when actual_steps < requested_steps due to clipping prevention.

clipping_detected: Option<ClippingDetection>

Clipping diagnostic the caller can format into a warning when prevent_clipping is off. None if no check ran (steps<=0 or wrap mode).

saturated_low: usize

MP3 global_gain values that clamped at 0 (silence) during a saturating apply, where the requested gain couldn’t be fully applied (issue #207). Always 0 for wrap mode and for predict_apply.

saturated_high: usize

MP3 global_gain values that clamped at 255 (distortion) during a saturating apply (issue #207).

gain_range: Option<(u8, u8)>

Post-apply (max, min) global_gain range across the modified MP3 frames, recorded during the apply pass so callers don’t need to re-read the file (issue #231). None for AAC, channel-specific applies, dry runs, and zero-frame applies.

Trait Implementations

impl Clone for ApplyReport

fn clone(&self) -> ApplyReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApplyReport

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

Formats the value using the given formatter.