yog 0.0.5

yog: a balls-oriented session manager for lernie loops (egui frontend)
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
102
103
104
105
106
107
108
109
110
111
112

//! **The shell's one spelling of a wire read** (REMOTE §1.2 and its
//! read-path residual; bl-adcb).
//!
//! Since the 2026-08-14 ruling the window is a client of its own engine over
//! loopback mTLS, so a surface that used to derive its content in process now
//! declares a standing question and paints whatever answer has landed
//! ([`AppModel::wire_ask`]). bl-ae05 wrote that shape out once, by hand, for the
//! clients section; a second copy of it in every migrated surface would be four
//! subtle arms restated per pane, and the subtle one is the third.
//!
//! The four states a read can be in, and what each paints:
//!
//! - **an answer of the expected kind** — its payload, which is the surface's
//!   whole content;
//! - **a refusal** — the engine's own sentence, painted rather than swallowed,
//!   because the wire is how this window reads and being told *no* is content;
//! - **nothing yet** — the honest empty state. The frame order is
//!   settle-then-render, so the first frame that declares a question paints
//!   before it has been asked and the answer lands one
//!   [`ASK_PERIOD`](crate::wire::asker::ASK_PERIOD) later;
//! - **an answer of another kind** — a codec that has drifted from the query it
//!   answers, which is a defect rather than a state (the round-trip tests are
//!   its witness). Nothing to paint, and nothing invented.
//!
//! **A surface that stops asking stops being asked.** The question is keyed by
//! its own encoded envelope, so a pane behind a collapsed header simply does not
//! call this and its answer is dropped at the next settle — no unsubscribe, and
//! no bookkeeping here to forget one.
//!
//! Coverage-excluded glue like the rest of `shell/*`: every decision below is a
//! match over [`Reply`], and the decode it matches on is covered where it lives.

use crate::AppModel;
use crate::boundary::reply::Reply;
use crate::boundary::{Gesture, Query, codec};

/// What one standing question has earned this frame: the payload if an answer
/// of the expected kind has landed, and the engine's sentence if it refused.
/// Both empty is the resting state of a question asked a moment ago.
pub(super) struct Landed<T> {
    pub(super) value: Option<T>,
    pub(super) refused: Option<String>,
}

/// **Nothing asked, nothing said** — what a surface that skipped the ask holds,
/// so a collapsed pane and an unanswered one are one code path rather than two.
/// Hand-written rather than derived because `T` need not be [`Default`]: the
/// absence is the `Option`'s, never a zero value of the payload's own type.
impl<T> Default for Landed<T> {
    fn default() -> Self {
        Self {
            value: None,
            refused: None,
        }
    }
}

/// **What a surface's questions were refused with**, in the order they were
/// first said and never twice (REMOTE §9.7, bl-13f9).
///
/// One surface, several standing questions: the §11 inspector declares up to
/// five at once, and when the refusal is the address resolution's — an
/// unregistered or unresolvable workspace — every one of them refuses in the
/// *same* sentence. Five copies of one sentence is a report about the
/// transport; one is content, which is the whole reason a refusal is painted
/// rather than swallowed.
#[derive(Default)]
pub(super) struct Said {
    sentences: Vec<String>,
}

impl Said {
    /// Take a landed payload, keeping its refusal if it had one.
    pub(super) fn take<T>(&mut self, landed: Landed<T>) -> Option<T> {
        if let Some(said) = landed.refused
            && !self.sentences.contains(&said)
        {
            self.sentences.push(said);
        }
        landed.value
    }

    /// The distinct sentences, oldest first.
    pub(super) fn sentences(self) -> Vec<String> {
        self.sentences
    }
}

/// Declare `query` standing and read whatever has landed for it, `take` picking
/// the payload out of the one [`Reply`] variant that query answers.
///
/// Never blocks and never dials: [`AppModel::wire_ask`] is a map read, and the
/// [`Asker`](crate::wire::asker::Asker) does the socket work off-frame at human
/// cadence.
pub(super) fn ask<T>(
    model: &mut AppModel,
    query: Query,
    take: fn(Reply) -> Option<T>,
) -> Landed<T> {
    let envelope = codec::encode(&Gesture::Ask(query));
    match model.wire_ask(&envelope) {
        Some(Ok(reply)) => Landed {
            value: take(reply),
            refused: None,
        },
        Some(Err(said)) => Landed {
            value: None,
            refused: Some(said),
        },
        None => Landed::default(),
    }
}