CargoLibrary 0.1.1

A library for Cargo by danielshih lab
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

//! # CargoLibrary
//!
//! `CargoLibrary` is a collection of utilities to make performing certain calculations more convenient.
//! cargo new CargoLibrary --lib

/// Adds two to the input number.
/// 
/// # Examples
/// ```
/// let result = CargoLibrary::add_two(2);
/// let answer = 4;
/// 
/// assert_eq!(result, answer);
/// ```
/// # Panics
/// 
/// # Errors
/// 
/// # Safety
/// 
/// # Abstraction
pub fn add_two(a: i32) -> i32 {
    a + 2
}


pub use self::Kinds::*;
pub use self::utils::*;

pub mod Kinds {
    pub enum PrimaryColors {
        Red,
        Blue,
        Yellow,
    }

    pub enum SecondaryColors {
        Orange,
        Green,
        Purple,
    }
}

pub mod utils {
    use crate::Kinds::*;

    /// Mixes two primary colors to produce a secondary color.
    /// a secondary color is produced by mixing two primary colors.
    pub fn mix(c1: PrimaryColors, c2: PrimaryColors) -> SecondaryColors {
        SecondaryColors::Orange
    }
}