girltest 0.1.0

THIS IS A TEST!
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

//! Girltest
//!
//! `girltest` is a module designed to enable operations involving girls.

/// Holds a girl.
#[derive(Debug)]
pub struct Girl {
    pub gender: String,
    pub sexuality: String,
    pub contains_boy: bool,
    pub name: u32,
    pub foot_name: Option<String>,
}

impl Girl {
    pub fn new_girl(gender: String, sexuality: String, contains_boy: bool, name: u32) -> Self {
        Girl {
            gender,
            sexuality,
            contains_boy,
            name,
            foot_name: None,
        }
    }

    pub fn get_gender(self: &Self) -> &String {
        &self.gender
    }

    pub fn get_sexuality(&self) -> &String {
        &self.sexuality
    }

    pub fn get_contains_boy(&self) -> bool {
        self.contains_boy
    }

    pub fn get_name(&self) -> u32 {
        self.name
    }

    /// Returns the starting initial of the `gender` field of a `Girl`.
    ///
    ///# Panics
    /// Panics if `gender` is an empty `String`.
    ///
    /// # Examples
    ///
    /// ```
    /// let girl = girltest::Girl::new_girl(
    ///     String::from("boy"),
    ///     String::from("gay"),
    ///     true,
    ///     32
    /// );
    ///
    /// assert_eq!("b", girl.gender_initial());
    /// ```
    pub fn gender_initial(&self) -> &str {
        &self.gender[..1]
    }
}