sprawling-runtime 0.0.9

One run of a sprawling resident, from dispatch to freeze: turns, tools, replay and the sandbox that executes code.
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

// 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

//! How a table is made and configured: the window its callers block for
//! before a command is handed to the background
//! (`crates/runtime/spec/Backlog.lean` §8-28), where a command's output
//! goes while it is inside that window (the same part, §8-28-3), and what
//! shares every run it starts asks for
//! (`crates/runtime/spec/Tools/Exec.lean` D29). The table itself, what it
//! carries and how it ends, is the module above.

use super::{Backlog, PollBudget, Scratch, Shares, Sink};

impl Backlog {
    #[must_use]
    pub fn new() -> Backlog {
        Backlog::default()
    }

    /// A table whose callers block for this window before a command is
    /// handed to the background.
    #[must_use]
    pub fn with_window(window: PollBudget) -> Backlog {
        Backlog {
            table: std::sync::Arc::default(),
            scratch: Scratch::open(),
            window,
            sink: None,
            shares: Shares::Unset,
        }
    }

    /// The same table, handing what a command writes to `sink` while
    /// the command is still inside its window (`crates/runtime/spec/Backlog.lean` §8-28-3).
    #[must_use]
    pub fn with_sink(self, sink: Sink) -> Backlog {
        Backlog {
            sink: Some(sink),
            ..self
        }
    }
}