knave 0.13.1

A Lisp programming language for humans and agents that infers types and ownership and compiles to readable 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
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
77

use super::functions::{ParamMode, ParamSlot};
use crate::types::CopyRules;

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum ValueKind {
    Moving,
    SmallCopy,
    LargeCopy,
}

impl ValueKind {
    pub fn of(slot: &ParamSlot, copy: &CopyRules) -> Self {
        if copy.is_small_copy(&slot.ty) {
            ValueKind::SmallCopy
        } else if copy.is_copy(&slot.ty) {
            ValueKind::LargeCopy
        } else {
            ValueKind::Moving
        }
    }

    pub fn starting_mode(self, rebuilt: bool) -> ParamMode {
        match self {
            ValueKind::SmallCopy | ValueKind::LargeCopy => ParamMode::Copy,
            ValueKind::Moving if rebuilt => ParamMode::Own,
            ValueKind::Moving => ParamMode::Ref,
        }
    }

    pub fn need(self, context: ParamMode) -> ParamMode {
        match (self, context) {
            (ValueKind::SmallCopy, ParamMode::Mut) => ParamMode::Mut,
            (ValueKind::SmallCopy, _) => ParamMode::Copy,
            _ => context,
        }
    }

    pub fn stronger(self, current: ParamMode, needed: ParamMode) -> ParamMode {
        let changes_caller = current == ParamMode::Mut || needed == ParamMode::Mut;
        match self {
            ValueKind::SmallCopy | ValueKind::LargeCopy if changes_caller => ParamMode::Mut,
            _ => current.max(needed),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::ValueKind;
    use crate::ownership::functions::ParamMode;

    #[test]
    fn a_change_outranks_a_read_of_a_copy_value() {
        assert_eq!(
            ValueKind::LargeCopy.stronger(ParamMode::Own, ParamMode::Mut),
            ParamMode::Mut
        );
    }

    #[test]
    fn a_move_outranks_a_change_of_a_moving_value() {
        assert_eq!(
            ValueKind::Moving.stronger(ParamMode::Mut, ParamMode::Own),
            ParamMode::Own
        );
    }

    #[test]
    fn a_small_copy_value_needs_no_borrow_to_be_read() {
        assert_eq!(ValueKind::SmallCopy.need(ParamMode::Ref), ParamMode::Copy);
    }

    #[test]
    fn a_large_copy_value_keeps_a_shared_borrow() {
        assert_eq!(ValueKind::LargeCopy.need(ParamMode::Ref), ParamMode::Ref);
    }
}