la-stack 0.4.3

Fast, stack-allocated linear algebra for fixed dimensions
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

#![forbid(unsafe_code)]

pub enum Error {
    Invalid,
}

// ruleid: la-stack.rust.no-public-api-panic-paths
pub fn panics_on_input(value: usize) -> usize {
    if value == 0 {
        panic!("zero is invalid");
    }
    value
}

// ruleid: la-stack.rust.no-public-api-panic-paths
pub const fn asserts_on_input(value: usize) -> usize {
    assert!(value > 0);
    value
}

// ruleid: la-stack.rust.no-public-api-panic-paths
pub fn unwraps_on_input(value: Option<usize>) -> usize {
    value.unwrap()
}

// ruleid: la-stack.rust.no-public-api-panic-paths
pub async fn expects_on_input(value: Option<usize>) -> usize {
    value.expect("value is required")
}

// ruleid: la-stack.rust.no-public-api-panic-paths
pub fn debug_asserts_on_input(value: usize) -> usize {
    debug_assert!(value > 0);
    value
}

// ruleid: la-stack.rust.no-public-api-panic-paths
pub fn marks_input_unreachable(value: usize) -> usize {
    if value == 0 {
        unreachable!("zero is not a valid public API path");
    }
    value
}

// ok: la-stack.rust.no-public-api-panic-paths
pub fn fallible_result(value: usize) -> Result<usize, Error> {
    if value == 0 {
        Err(Error::Invalid)
    } else {
        Ok(value)
    }
}

// ok: la-stack.rust.no-public-api-panic-paths
pub fn fallible_option(value: usize) -> Option<usize> {
    if value == 0 { None } else { Some(value) }
}

// ok: la-stack.rust.no-public-api-panic-paths
pub fn total(value: usize) -> usize {
    value + 1
}

// ok: la-stack.rust.no-public-api-panic-paths
pub(crate) fn crate_private_literal_helper(value: usize) -> usize {
    assert!(value > 0);
    value
}

#[cfg(test)]
mod tests {
    // ok: la-stack.rust.no-public-api-panic-paths
    pub(crate) fn test_only_helper(value: usize) -> usize {
        value.expect("test fixture has a value")
    }
}