circlejerk 0.1.0

Small arithmetic helpers for Rust
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

//! Small arithmetic helpers.

/// Adds two unsigned 64-bit integers.
///
/// # Examples
///
/// ```
/// assert_eq!(circlejerk::add(2, 2), 4);
/// ```
///
/// # Panics
///
/// Panics on integer overflow when overflow checks are enabled.
#[must_use]
pub fn add(left: u64, right: u64) -> u64 {
    left + right
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn it_works() {
        let result = add(2, 2);
        assert_eq!(result, 4);
    }
}