kuliya 0.1.3

A library for querying Algerian education dataset.
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

//! Node module contains the Node struct and its nested structs for the `static` feature.

use nest_struct::nest_struct;
#[cfg(feature = "serde_derive")]
use serde::Serialize;

#[nest_struct]
/// A Node is a struct that contains the name and the type of the node
#[derive(Debug, PartialEq)]
#[cfg_attr(feature = "serde_derive", derive(Serialize))]
pub struct Node {
    /// Node code
    pub code: &'static str,
    /// Node name
    pub name: nest! {
        /// A NodeName is a struct that contains the name of the node in three languages
        #[derive(Debug, PartialEq)]
        #[cfg_attr(feature = "serde_derive", derive(Serialize))]
        pub struct NodeName {
            /// Arabic name
            pub ar: &'static str,
            /// English name
            pub en: &'static str,
            /// French name
            pub fr: &'static str,
        }
    },
    /// Node type information
    #[cfg_attr(feature = "serde_derive", serde(flatten))]
    pub r#type: nest! {
        /// A NodeType is an enum that represents the type of the node
        #[derive(Debug, PartialEq)]
        #[cfg_attr(feature = "serde_derive", derive(Serialize), serde(tag = "type"), serde(rename_all = "UPPERCASE"))]
        pub enum NodeType {
            /// University is the highest level of education in Algeria
            University,
            /// Academy is a type of university
            Academy,
            /// School is also a type of university
            PrivateSchool,
            /// Institute is a type of university
            Institute,
            /// Faculty is level 2 in the hierarchy
            Faculty,
            /// Department is level 3 in the hierarchy
            Department,
            /// Specialty is level 4 in the hierarchy
            Specialty {
                /// Terms information for the specialty
                terms: nest! {
                    /// A NodeTerms is a struct that contains the number of terms per year and the slot placement for each term
                    #[derive(Debug, PartialEq, Clone)]
                    #[cfg_attr(feature = "serde_derive", derive(Serialize), serde(rename_all = "camelCase"))]
                    pub struct NodeTerms {
                        /// Number Terms per year
                        pub per_year: usize,
                        /// Slot placement for each term
                        pub slots: &'static [i32],
                    }
                }
            },
            /// Sector is same level as Specialty
            Sector {
                /// Terms information for the sector
                terms: NodeTerms
            },
        }
    },
}