caesura 0.31.0

An all-in-one command line tool to transcode FLAC audio files and upload to gazelle based indexers/trackers
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

use crate::prelude::*;

/// A job is a stand-alone object that contains all the information needed to perform
/// a piece of work.
///
/// Effectively it's a [command design pattern](https://refactoring.guru/design-patterns/command)
/// but in Command in Rust specifically refers to executing an external program so the term Job
/// will suffice.
///
/// Jobs can be executed by themselves, but they're intended to be executed in parallel
/// by a [`JobRunner`].
///
/// In theory, they could produce a result but the implement here is `Result<()>`.
pub enum Job {
    /// Resize and copy an additional file.
    Additional(AdditionalJob),
    /// Generate a spectrogram image.
    Spectrogram(SpectrogramJob),
    /// Transcode a FLAC file.
    Transcode(TranscodeJob),
}

/// A command that can be executed in parallel.
///
/// A [command design pattern](https://refactoring.guru/design-patterns/command) is used
/// so the execution of the command can be deferred and multiple commands can be executed
/// in parallel via the multithreaded [`JobRunner`].
impl Job {
    /// Get the ID of the wrapped command.
    #[must_use]
    pub fn get_id(&self) -> String {
        match self {
            Job::Additional(job) => job.id.clone(),
            Job::Spectrogram(job) => job.id.clone(),
            Job::Transcode(job) => job.id.clone(),
        }
    }

    /// Execute the wrapped command.
    pub async fn execute(self) -> Result<(), Failure<JobAction>> {
        match self {
            Job::Additional(job) => job
                .execute()
                .await
                .map_err(Failure::wrap(JobAction::Additional)),
            Job::Spectrogram(job) => job
                .execute()
                .await
                .map_err(Failure::wrap(JobAction::Spectrogram)),
            Job::Transcode(job) => job
                .execute()
                .await
                .map_err(Failure::wrap(JobAction::Transcode)),
        }
    }
}