falsefox 0.1.4

Package experiment for falsefox
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

// 2024-05-03 falsefox
// GPL 3.0 Licensed

//! ## falsefox is an experiment by falsefox.
//! The crate is not intended to be that useful, it is mostly here as a learning utility.
//! 
//! ## Example
//! ```rust
//! use falsefox;
//! fn main () {
//!     println!("{:?}", falsefox::get_github());
//!     // https://github.com/false-fox
//! }
//! ```

pub struct Info {
    pub name: String,
    pub pronouns: Vec<String>,
    pub email: String,
    pub github: String,
    pub website: String,
}

/// The builder for the [`Info`] struct which populates it with falsefox's information.
pub fn builder() -> Info {
    let falsefox_info: Info = Info {
        name: String::from("Fox"),
        pronouns: vec![String::from("she/her")],
        email: String::from("me@falsefox.dev"),
        github: String::from("https://github.com/false-fox"),
        website: String::from("https://falsefox.dev"),
    };
    falsefox_info
}

/// Returns the built [`Info`] struct.
pub fn get_info() -> Info {
    builder()
}

/// Returns just the email property from the built [`Info`] struct.
pub fn get_email() -> String {
    builder().email
}

/// Returns just the name property from the built [`Info`] struct.
pub fn get_name() -> String {
    builder().name
}

/// Returns just the github property from the built [`Info`] struct.
pub fn get_github() -> String {
    builder().github
}

/// Returns just the website property from the built [`Info`] struct.
pub fn get_website() -> String {
    builder().website
}

/// Returns just the pronouns property from the built [`Info`] struct.
pub fn get_pronouns() -> Vec<String> {
    builder().pronouns
}

#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn test_get_functions() {
        assert_eq!(builder().website, get_website());
        assert_eq!(builder().github, get_github());
        assert_eq!(builder().pronouns, get_pronouns());
        assert_eq!(builder().name, get_name());
        assert_eq!(builder().email, get_email());
    }
}