Struct ApplyOptions 

#[non_exhaustive]
pub struct ApplyOptions {
    pub steps: i32,
    pub track_result: Option<ReplayGainResult>,
    pub album_info: Option<AacAlbumInfo>,
    pub prevent_clipping: bool,
    pub wrap: bool,
    pub preserve_timestamp: bool,
    pub use_temp_file: bool,
    pub write_undo: bool,
    pub write_replaygain_tags: bool,
    pub use_id3v2: bool,
    pub channel: Option<Channel>,
    pub skip_clipping_check: bool,
}

Driver configuration for apply_with_options.

Construct via ApplyOptions::new and tweak fields directly — this struct is data-only, no builder methods.

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.

steps: i32

Requested gain in MP3 gain steps (1 step = 1.5 dB).

track_result: Option<ReplayGainResult>

Per-track ReplayGain analysis. Provides peak() for the ReplayGain-based clipping check and gain_db() / peak() for ReplayGain tag writing.

album_info: Option<AacAlbumInfo>

Album-level info that feeds the album fields of the ReplayGain tags.

prevent_clipping: bool

-k: if the requested gain would clip, cap it at the available headroom instead of applying as-is.

wrap: bool

-w: wrap around 0–255 instead of saturating. Also disables the clipping check (wrap mode is intentionally lossy).

preserve_timestamp: bool

-p: restore the file’s mtime after writing.

use_temp_file: bool

-t: historically opted into temp-file writes. All file rewrites now go through a sibling temp file + atomic rename unconditionally (issue #227), so the flag is accepted but has no effect.

write_undo: bool

Record an undo tag (APE for MP3, MP4 freeform for AAC, ID3v2 TXXX when Self::use_id3v2 is on).

write_replaygain_tags: bool

Write ReplayGain metadata tags. Requires Self::track_result to be set. AAC writes to mp4 freeform metadata; MP3 writes ID3v2 TXXX frames when Self::use_id3v2 is on, otherwise APEv2 REPLAYGAIN_* items (issue #204).

use_id3v2: bool

-s i: MP3 only — use ID3v2 TXXX frames for undo and ReplayGain instead of APE.

channel: Option<Channel>

-l: MP3 only — apply gain to a single channel (Stereo / Dual Channel) instead of all channels. AAC has no per-channel apply path; setting this on an AAC file is an error.

skip_clipping_check: bool

Skip the pre-apply clipping check entirely. For callers that will never surface ApplyReport::clipping_detected (-c / -q, or the channel path), the headroom check’s full-file analyze() is pure waste (issue #232). Ignored when Self::prevent_clipping is on — -k needs the check to cap the gain.

Implementations

impl ApplyOptions

pub fn new(steps: i32) -> Self

Construct with a requested step count and “safe” defaults (undo on, no temp file, no clipping prevention, no tag writing).

Trait Implementations

impl Clone for ApplyOptions

fn clone(&self) -> ApplyOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApplyOptions

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

Formats the value using the given formatter.