rustpkg/lib.rs
1//! # Rustpkg
2//!
3//! The `rustpkg` library is a testing library.
4//!
5
6/// Addition function
7///
8/// # Examples
9///
10/// ```
11/// let a = 1;
12/// let b = 2;
13/// let got = rustpkg::add(a, b);
14///
15/// assert_eq!(got, 3);
16/// ```
17///
18/// # Panics
19///
20/// never panic.
21///
22/// # Errors
23///
24/// never return error.
25///
26/// # Safety
27///
28/// It is safe.
29///
30pub fn add(left: usize, right: usize) -> usize {
31 left + right
32}
33
34#[cfg(test)]
35mod tests {
36 use super::*;
37
38 #[test]
39 fn it_works() {
40 let result = add(2, 2);
41 assert_eq!(result, 4);
42 }
43}