ikarusdef 0.1.4

A tool describing Ikarus' capabilities
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

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct Type {
    pub description: &'static str,
    pub name: &'static str,
    pub functions: Vec<Function>,
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct Function {
    pub name: &'static str,
    pub description: &'static str,
    pub log_level: LogLevel,
    pub db_access: DbAccess,
    pub versions: Vec<FunctionVersion>,
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct FunctionVersion {
    pub description: Option<&'static str>,
    pub log_level: Option<LogLevel>,
    pub db_access: Option<DbAccess>,
    pub flags: Vec<Flag>,
    pub parameters: Vec<Parameter>,
    pub r#return: Option<ReturnType>,
    pub errors: Vec<Error>,
}

#[derive(Copy, Clone, Debug, Eq, PartialEq)]
pub enum LogLevel {
    NoLog,
    Verbose,
    Info,
}

#[derive(Copy, Clone, Debug, Eq, PartialEq)]
pub enum DbAccess {
    NoAccess,
    ReadOnly,
    ReadWrite,
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct Flag {
    pub name: &'static str,
    pub description: &'static str,
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct Parameter {
    pub name: &'static str,
    pub r#type: &'static str,
    pub description: &'static str,
    pub log_level: LogLevel,
    pub validations: Vec<ParameterValidation>,
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct ReturnType {
    pub name: &'static str,
    pub r#type: &'static str,
    pub description: &'static str,
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct Error {
    pub r#type: &'static str,
    pub occurrences: Vec<&'static str>,
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct ParameterValidation {
    pub r#type: ParameterValidationType,
    pub flag_condition: Option<FlagCondition>,
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct FlagCondition {
    pub inverted: bool,
    pub flag: &'static str,
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub enum ParameterValidationType {
    NotNull,
    IdNotNull,
    IdNotNone,
    IdSpecified,
    Exists,
    PositionWithinBounds {
        bounds_folder_object: &'static str,
    },
    Is {
        expected_types: Vec<&'static str>,
    },
    ValidPath,
    ValidUtf8,
    NotBlank,
    PathExists,
    PathParentMustExist,
    ValidPropertyValue {
        type_source: &'static str,
        settings_source: &'static str,
    },
    ValidPropertyValueDb {
        property_source: &'static str,
    },
    ValidSettings {
        type_source: &'static str,
    },
    ValidSettingsDb {
        property_source: &'static str,
    },
}