trane 0.28.0

An automated system for learning complex skills
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
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

//! Contains the errors returned by Trane.

use thiserror::Error;
use ustr::Ustr;

use crate::data::UnitType;

/// An error returned when dealing with the blacklist.
#[derive(Debug, Error)]
#[allow(missing_docs)]
pub enum BlacklistError {
    #[error("cannot add unit {0} to the blacklist: {1}")]
    AddUnit(Ustr, #[source] anyhow::Error),

    #[error("cannot get entries from the blacklist: {0}")]
    GetEntries(#[source] anyhow::Error),

    #[error("cannot remove entries with prefix {0} from the blacklist: {1}")]
    RemovePrefix(String, #[source] anyhow::Error),

    #[error("cannot remove unit {0} from the blacklist: {1}")]
    RemoveUnit(Ustr, #[source] anyhow::Error),
}

/// An error returned when dealing with the exercise scheduler.
#[derive(Debug, Error)]
#[allow(missing_docs)]
pub enum ExerciseSchedulerError {
    #[error("cannot retrieve exercise batch: {0}")]
    GetExerciseBatch(#[source] anyhow::Error),

    #[error("cannot score exercise: {0}")]
    ScoreExercise(#[source] anyhow::Error),

    #[error("cannot get score for unit {0}: {1}")]
    GetUnitScore(Ustr, #[source] anyhow::Error),
}

/// An error returned when dealing with the practice stats.
#[derive(Debug, Error)]
#[allow(missing_docs)]
pub enum PracticeRewardsError {
    #[error("cannot get rewards for unit {0}: {1}")]
    GetRewards(Ustr, #[source] anyhow::Error),

    #[error("cannot record rewards: {0}")]
    RecordRewards(#[source] anyhow::Error),

    #[error("cannot trim rewards: {0}")]
    TrimReward(#[source] anyhow::Error),

    #[error("cannot remove rewards from units matching prefix {0}: {1}")]
    RemovePrefix(String, #[source] anyhow::Error),
}

/// An error returned when dealing with the practice stats.
#[derive(Debug, Error)]
#[allow(missing_docs)]
pub enum PracticeStatsError {
    #[error("cannot get scores for unit {0}: {1}")]
    GetScores(Ustr, #[source] anyhow::Error),

    #[error("cannot record score for unit {0}: {1}")]
    RecordScore(Ustr, #[source] anyhow::Error),

    #[error("cannot trim scores: {0}")]
    TrimScores(#[source] anyhow::Error),

    #[error("cannot remove scores from units matching prefix {0}: {1}")]
    RemovePrefix(String, #[source] anyhow::Error),
}

/// An error returned when dealing with user preferences.
#[derive(Debug, Error)]
#[allow(missing_docs)]
pub enum PreferencesManagerError {
    #[error("cannot get user preferences: {0}")]
    GetUserPreferences(#[source] anyhow::Error),

    #[error("cannot set user preferences: {0}")]
    SetUserPreferences(#[source] anyhow::Error),
}

/// An error returned when dealing with git repositories containing courses.
#[derive(Debug, Error)]
#[allow(missing_docs)]
pub enum RepositoryManagerError {
    #[error("cannot add repository with URL {0}: {1}")]
    AddRepo(String, #[source] anyhow::Error),

    #[error("cannot list repositories: {0}")]
    ListRepos(#[source] anyhow::Error),

    #[error("cannot get repository with ID {0}: {1}")]
    RemoveRepo(String, #[source] anyhow::Error),

    #[error("cannot update repository with ID {0}: {1}")]
    UpdateRepo(String, #[source] anyhow::Error),

    #[error("cannot update repositories: {0}")]
    UpdateRepos(#[source] anyhow::Error),
}

/// An error returned when dealing with the review list.
#[derive(Debug, Error)]
#[allow(missing_docs)]
pub enum ReviewListError {
    #[error("cannot add unit {0} to the review list: {1}")]
    AddUnit(Ustr, #[source] anyhow::Error),

    #[error("cannot retrieve the entries from the review list: {0}")]
    GetEntries(#[source] anyhow::Error),

    #[error("cannot remove unit {0} from the review list: {1}")]
    RemoveUnit(Ustr, #[source] anyhow::Error),
}

/// An error returned when downloading transcription assets.
#[derive(Debug, Error)]
#[allow(missing_docs)]
pub enum TranscriptionDownloaderError {
    #[error("cannot download asset for exercise {0}: {1}")]
    DownloadAsset(Ustr, #[source] anyhow::Error),
}

/// An error returned when dealing with the unit graph.
#[derive(Debug, Error)]
#[allow(missing_docs)]
pub enum UnitGraphError {
    #[error("cannot add dependencies for unit {0} of type {1} to the unit graph: {2}")]
    AddDependencies(Ustr, UnitType, #[source] anyhow::Error),

    #[error("cannot add encompassed units for unit {0} to the unit graph: {1}")]
    AddEncompassed(Ustr, #[source] anyhow::Error),

    #[error("cannot add unit {0} of type {1} to the unit graph: {2}")]
    AddUnit(Ustr, UnitType, #[source] anyhow::Error),

    #[error("checking for cycles in the unit graph failed: {0}")]
    CheckCycles(#[source] anyhow::Error),
}