escriba-core 0.1.3

Foundational types for the escriba editor — Position, Range, Cursor, Selection, Mode, Motion, Operator, Edit, Action. No I/O, no rendering, pure types.
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

//! Opaque identifiers — one counter per domain. All are transparent newtypes
//! so serde emits them as plain numbers.

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

macro_rules! id_type {
    ($name:ident, $doc:literal) => {
        #[doc = $doc]
        #[derive(
            Debug,
            Clone,
            Copy,
            PartialEq,
            Eq,
            PartialOrd,
            Ord,
            Hash,
            Default,
            Serialize,
            Deserialize,
            JsonSchema,
        )]
        #[serde(transparent)]
        pub struct $name(pub u64);

        impl std::fmt::Display for $name {
            fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
                write!(f, "{}#{}", stringify!($name), self.0)
            }
        }
    };
}

id_type!(
    BufferId,
    "Identifies one open buffer — unique across the editor session."
);
id_type!(
    WindowId,
    "Identifies one UI window (one viewport over a buffer)."
);
id_type!(
    CaretId,
    "Identifies a caret within a selection, stable across edits."
);

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

    #[test]
    fn ids_are_newtypes() {
        let a = BufferId(1);
        let b = BufferId(1);
        assert_eq!(a, b);
        let s = serde_json::to_string(&a).unwrap();
        assert_eq!(s, "1");
    }

    #[test]
    fn display_format() {
        assert_eq!(BufferId(42).to_string(), "BufferId#42");
    }
}