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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

// Souk - task_result.rs
// Copyright (C) 2022-2023  Felix Häcker <haeckerfelix@gnome.org>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

use serde::{Deserialize, Serialize};
use zbus::zvariant::{Optional, Type};

use crate::shared::flatpak::dry_run::DryRun;
use crate::shared::WorkerError;

#[derive(Deserialize, Serialize, Type, PartialEq, Debug, Clone)]
pub struct TaskResult {
    pub kind: TaskResultKind,
    pub dry_run: Optional<DryRun>,
    pub error: Optional<WorkerError>,
}

impl TaskResult {
    pub fn new_done() -> Self {
        Self {
            kind: TaskResultKind::Done,
            dry_run: None.into(),
            error: None.into(),
        }
    }

    pub fn new_dry_run(dry_run: DryRun) -> Self {
        Self {
            kind: TaskResultKind::DoneDryRun,
            dry_run: Some(dry_run).into(),
            error: None.into(),
        }
    }

    pub fn new_error(error: WorkerError) -> Self {
        Self {
            kind: TaskResultKind::Error,
            dry_run: None.into(),
            error: Some(error).into(),
        }
    }

    pub fn new_cancelled() -> Self {
        Self {
            kind: TaskResultKind::Cancelled,
            dry_run: None.into(),
            error: None.into(),
        }
    }
}

impl Default for TaskResult {
    fn default() -> Self {
        Self {
            kind: TaskResultKind::None,
            dry_run: None.into(),
            error: None.into(),
        }
    }
}

#[derive(Default, Deserialize, Serialize, Type, Eq, PartialEq, Debug, Clone, Hash)]
pub enum TaskResultKind {
    /// Task completed successfully.
    Done,
    /// Task completed successfully, with an [DryRun] as result
    DoneDryRun,
    /// Task failed. See [ResponseType.error] for more details.
    Error,
    /// Task got cancelled (most likely by user).
    Cancelled,
    #[default]
    None,
}