sprawling-kernel 0.0.9

Every decision of a sprawling city - addresses, events, gates, plans and errors - with nothing that touches a disk.
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.
// Copyright (c) 2026 2youg1 and the sprawling contributors

//! What a resident did to a plan node: the one payload the five
//! `roadmap_*` kinds share.

use serde::{Deserialize, Serialize};

use crate::NodeId;
use crate::locator::Locator;
use crate::plan::StopCause;

/// `roadmap_claimed`, `roadmap_split`, `roadmap_finished`,
/// `roadmap_released` and `roadmap_blocked`: who moved which node, and
/// the step. The five lines share `by`, `node` and `verb` and differ
/// only in what follows the verb, so one struct holds them and the verb
/// selects the step.
///
/// `node` reads back through [`NodeId::parse`]; a line whose node is not
/// an index is refused, because a reader that skipped it would count a
/// held node as free.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct RoadmapMoved {
    pub by: String,
    pub node: NodeId,
    #[serde(flatten)]
    pub step: RoadmapStep,
}

/// The step a `roadmap_*` line records, spelled by its `verb` key.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(tag = "verb", rename_all = "snake_case")]
pub enum RoadmapStep {
    Claimed {
        item: String,
    },
    Split {
        children: Vec<String>,
    },
    Finished {
        item: String,
        evidence: Locator,
    },
    Released {
        item: String,
        why: StopCause,
        line: String,
    },
    Blocked {
        item: String,
        why: StopCause,
        line: String,
    },
}

#[cfg(test)]
#[allow(clippy::unwrap_used, reason = "test code")]
mod tests {
    use super::*;
    use crate::event::Payload;

    /// The bytes `collab::claim_effect` wrote by hand for a claim and a
    /// block, and the claim read back whole.
    #[test]
    fn a_roadmap_line_writes_the_keys_the_hand_written_map_wrote() {
        let claimed = RoadmapMoved {
            by: "lab/parser".to_owned(),
            node: NodeId::parse("2.3").unwrap(),
            step: RoadmapStep::Claimed {
                item: "the lexer".to_owned(),
            },
        };
        let blocked = RoadmapMoved {
            by: "lab/parser".to_owned(),
            node: NodeId::parse("2").unwrap(),
            step: RoadmapStep::Blocked {
                item: "the lexer".to_owned(),
                why: StopCause::Stalled { repeats: 3 },
                line: "stalled".to_owned(),
            },
        };
        let bytes =
            |record: &RoadmapMoved| serde_json::to_string(&Payload::of(record).unwrap()).unwrap();
        assert_eq!(
            (bytes(&claimed), bytes(&blocked)),
            (
                r#"{"by":"lab/parser","item":"the lexer","node":"2.3","verb":"claimed"}"#.to_owned(),
                r#"{"by":"lab/parser","item":"the lexer","line":"stalled","node":"2","verb":"blocked","why":{"stalled":{"repeats":3}}}"#.to_owned(),
            )
        );
        assert_eq!(
            Payload::of(&claimed)
                .unwrap()
                .read::<RoadmapMoved>()
                .unwrap(),
            claimed
        );
    }
}