Struct EffectiveSettings 

pub struct EffectiveSettings {

    pub token: Option<String>,
    pub stored_token: Option<String>,
    pub token_command: Option<String>,
    pub account_id: Option<String>,
    pub format: AudioFormat,
    pub concurrency: u32,
    pub retries: u32,
    pub min_newest: u32,
    pub animated_covers: bool,
    pub raw_animated_cover: bool,
    pub video_cover_retention: VideoCoverRetention,
    pub animated_cover_webp: WebpEncodeSettings,
    pub details_sidecar: bool,
    pub lyrics_sidecar: bool,
    pub lrc_sidecar: bool,
    pub video_mp4: bool,
    pub download_stems: bool,
    pub stem_format: StemFormat,
    pub naming_template: String,
    pub character_set: CharacterSet,
    pub areas: Option<AreasConfig>,
    pub album_overrides: BTreeMap<String, String>,
}

Resolved effective settings for one account/source combination.

Fields

token: Option<String>

A direct token from --token or SUNO_*_TOKEN.

stored_token: Option<String>

A stored token from [accounts.<label>].token.

token_command: Option<String>

A command to run for the token when no direct token was supplied.

account_id: Option<String>

The optional configured account id assertion (see AccountConfig).

format: AudioFormat

concurrency: u32

retries: u32

min_newest: u32

animated_covers: bool

raw_animated_cover: bool

Keep the raw album cover.mp4 (video_cover_url verbatim, no transcode). Driven by VideoCoverRetention::keeps_mp4; independent of video_mp4.

video_cover_retention: VideoCoverRetention

animated_cover_webp: WebpEncodeSettings

details_sidecar: bool

lyrics_sidecar: bool

lrc_sidecar: bool

video_mp4: bool

download_stems: bool

stem_format: StemFormat

naming_template: String

character_set: CharacterSet

areas: Option<AreasConfig>

The per-account [areas] selection table, if configured.

album_overrides: BTreeMap<String, String>

Manual album-name overrides, keyed by lineage root id, resolved from the account’s [accounts.<label>.albums] table. Deterministically ordered (a BTreeMap) and pre-trimmed of empty values by Config::resolve.

Implementations

impl EffectiveSettings

pub fn requires_ffmpeg(&self) -> bool

Returns true when these settings require ffmpeg to be on PATH.

FLAC output transcodes WAV→FLAC, and an animated WebP cover transcodes MP4→WebP, so either needs ffmpeg. Keeping the raw MP4 alongside the WebP (the both retention) still produces the WebP, so animated_covers alone decides it; a raw-MP4-only run, or a plain MP3/WAV run with no animated covers, needs no ffmpeg.

Trait Implementations

impl Clone for EffectiveSettings

fn clone(&self) -> EffectiveSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EffectiveSettings

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

Formats the value using the given formatter.

impl PartialEq for EffectiveSettings

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for EffectiveSettings