sprawling-wire 0.0.12

The process boundary of a sprawling city: the frames its clients speak, and the server that answers them.
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

// 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 `Command::PrivacyOperation` asks for, and the result the host
//! keeps for it under its `idem` (`crates/wire/spec/Privacy.lean` ยง8-89).

use kernel::{AxError, IdemKey};
use serde::{Deserialize, Serialize};

use super::answer::PrivacyValue;
use super::{PrivacyControl, PrivacyFaultCode, PrivacySettlement};

/// Change one host privacy control, or check the operation that has no
/// conclusion: the payload of `Command::PrivacyOperation`. The city's
/// listener carries it out on the host, and its result is read back from
/// [`crate::PrivacyAnswer::outcomes`] under `idem`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct PrivacyRequest {
    pub action: PrivacyAction,
    pub idem: IdemKey,
}

/// One change the person confirmed on the page. `expected` is the value
/// the page showed when the person confirmed; the host writes nothing when
/// its fresh read differs (`crates/sprawling/spec/Privacy/Confirmation.lean`
/// D58).
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub enum PrivacyAction {
    /// Write the control's value over `expected`.
    Apply {
        control: PrivacyControl,
        expected: PrivacyValue,
    },
    /// Put back the value this app's latest change of the control found.
    Restore {
        control: PrivacyControl,
        expected: PrivacyValue,
    },
    /// The person's check of the operation that has no conclusion:
    /// `expected` is the value the page showed for its control. Writes
    /// nothing.
    Reconcile { expected: PrivacyValue },
}

/// The result kept for one operation a page sent.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct PrivacyOutcome {
    pub idem: IdemKey,
    pub action: PrivacyAction,
    pub result: PrivacyResult,
}

/// Where one operation stands.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub enum PrivacyResult {
    /// Accepted and not finished: it waits for an earlier operation, for
    /// administrator approval, or for its readback.
    Running,
    /// `operation` is the history's number for it, never zero.
    Applied {
        operation: u64,
    },
    Restored {
        operation: u64,
    },
    /// The target already held the control's value; nothing was written
    /// or recorded.
    AlreadyWritten,
    Reconciled {
        operation: u64,
        settlement: PrivacySettlement,
    },
    /// The change asked for did not happen, or its result is unconfirmed;
    /// `error` says which and what to do.
    Refused {
        code: PrivacyFaultCode,
        error: AxError,
    },
}