Struct AnalyzeRequest 

pub struct AnalyzeRequest<'a> {
    pub stem: &'a Path,
    pub bpm: Bpm,
    pub bpm_exact: bool,
    pub synth: Synth,
    pub notes: Option<&'a Path>,
    pub profile: Option<Profile>,
    pub out: Option<&'a Path>,
    pub force: bool,
}

What analyze reads and where it writes.

Fields

stem: &'a Path

The audio stem.

bpm: Bpm

The tempo of the stem, refined from the stem unless bpm_exact.

bpm_exact: bool

Use bpm as it is.

synth: Synth

The target synth, written into the report.

notes: Option<&'a Path>

A MIDI file with the stem’s notes. Without it the notes step runs.

profile: Option<Profile>

The profile that overrides detection in the notes step, if any. The notes step does not run when notes gives the notes, so the profile then has no effect; the command line rejects the two together.

out: Option<&'a Path>

The output folder; by default <stem folder>/<stem file stem>/.

force: bool

Replace files in the output folder that no report of this stem owns: a report or notes of another stem, a report of the same name with other content, a file that is not this tool’s, or a spectrogram.png without a report.

Implementations

impl AnalyzeRequest<'_>

pub fn out_dir(&self) -> Result<PathBuf, AnalyzeError>

Returns the output folder.

Errors

AnalyzeError::NoFolderName without out for a stem whose name has no extension or is . or .. without it.

pub fn source(&self) -> String

Returns the file name of the stem, as the report records it.

Trait Implementations

impl<'a> Clone for AnalyzeRequest<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for AnalyzeRequest<'a>

impl<'a> Debug for AnalyzeRequest<'a>

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

Formats the value using the given formatter.