macroonz-harness 0.2.0

Safe-Rust property, fuzz, fault, schedule, mutation, network, and benchmark testing with typed evidence, reduction, and replay.
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

//! The custody roads: where a sink stored a proposal, and what a completed human admission retains.

use crate::depot::capsules::{ReplayCapsuleEntry, StoredReplayEntryRef};
use crate::descriptor::{ProposalId, Row};
use crate::muterprater::proposal::types::{
    DischargeAdmissionReceipt, ReplayAdmissionReceipt, SinkRefusal, StoredProposalRef,
};

// ---------------------------------------------------------------------------
// Custody, and the admission receipts.
// ---------------------------------------------------------------------------

impl StoredProposalRef {
    /// Bind a sink's storage location to the proposal it stored.
    ///
    /// # Errors
    ///
    /// Refuses an empty token, which names nowhere.
    pub fn at(proposal: ProposalId, token: &str) -> Result<Self, SinkRefusal> {
        if token.is_empty() {
            return Err(SinkRefusal::EmptyLocation);
        }
        Ok(Self {
            proposal,
            token: token.to_owned(),
        })
    }

    /// The content identity of the proposal stored at this location.
    #[must_use]
    pub const fn proposal(&self) -> ProposalId {
        self.proposal
    }

    /// The token, for a sink to read its own location back.
    #[must_use]
    pub fn token(&self) -> &str {
        &self.token
    }
}

impl ReplayAdmissionReceipt {
    /// Retain the exact outputs of one completed replay-bearing human admission.
    #[must_use]
    pub(in crate::muterprater) fn completed(
        row: Row,
        entry: ReplayCapsuleEntry,
        proposal_custody: StoredProposalRef,
        replay_custody: StoredReplayEntryRef,
    ) -> Self {
        Self {
            row,
            entry,
            proposal_custody,
            replay_custody,
        }
    }

    /// The row whose candidate origin became human-admitted provenance.
    #[must_use]
    pub const fn row(&self) -> &Row {
        &self.row
    }

    /// The exact capsule entry the human admission stored.
    #[must_use]
    pub const fn entry(&self) -> &ReplayCapsuleEntry {
        &self.entry
    }

    /// The caller's review-durable custody of the proposal.
    #[must_use]
    pub const fn proposal_custody(&self) -> &StoredProposalRef {
        &self.proposal_custody
    }

    /// The caller's storage location for the replay entry.
    #[must_use]
    pub const fn replay_custody(&self) -> &StoredReplayEntryRef {
        &self.replay_custody
    }
}

impl DischargeAdmissionReceipt {
    /// Retain the outputs of one completed obligation-discharge human admission.
    #[must_use]
    pub(in crate::muterprater) fn completed(row: Row, proposal_custody: StoredProposalRef) -> Self {
        Self {
            row,
            proposal_custody,
        }
    }

    /// The row whose candidate origin became human-admitted provenance.
    #[must_use]
    pub const fn row(&self) -> &Row {
        &self.row
    }

    /// The caller's review-durable custody of the proposal.
    #[must_use]
    pub const fn proposal_custody(&self) -> &StoredProposalRef {
        &self.proposal_custody
    }
}