rsaeb 0.10.1

A no_std + alloc interpreter for A=B ordered rewrite programs.
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

use crate::error::{TraceSnapshotError, TraceSnapshotRunError, TracedRunError};
use crate::input::RunSeed;
use crate::limits::TraceSnapshotByteLimit;
use crate::trace::{BorrowedTraceEvent, TraceSnapshotEvent};

use super::Program;
use super::result::RunResult;

/// Trace callback failure split used while borrowed events become snapshots.
enum SnapshotTraceCallbackError<E> {
    /// Snapshot materialization failed before the user callback ran.
    Snapshot(TraceSnapshotError),
    /// User callback rejected a materialized snapshot event.
    Trace(E),
}

impl Program {
    /// Runs this program and emits owned trace snapshot events.
    ///
    /// This API materializes bounded `Vec<u8>` snapshots for the initial state
    /// and every committed step. Use [`Program::run_with_borrowed_trace`] when
    /// the trace sink only needs to inspect each event during the callback.
    /// Snapshot limits are evaluated per event; a too-large event is reported
    /// as a snapshot failure before the user callback receives a truncated
    /// value.
    ///
    /// # Errors
    ///
    /// Returns `TraceSnapshotRunError::Run` for runtime failures.
    /// Returns `TraceSnapshotRunError::Snapshot` when snapshot materialization
    /// exceeds `snapshot_byte_limit` or allocation fails. Returns
    /// `TraceSnapshotRunError::Trace` when the user-provided trace callback
    /// returns an error.
    pub fn run_with_trace_snapshots<'program, F, E>(
        &'program self,
        seed: RunSeed,
        snapshot_byte_limit: TraceSnapshotByteLimit,
        mut trace: F,
    ) -> Result<RunResult, TraceSnapshotRunError<E>>
    where
        F: FnMut(TraceSnapshotEvent<'program>) -> Result<(), E>,
    {
        let result = self.run_with_borrowed_trace(seed, |event| {
            let snapshot = event
                .to_snapshot(snapshot_byte_limit)
                .map_err(SnapshotTraceCallbackError::Snapshot)?;
            trace(snapshot).map_err(SnapshotTraceCallbackError::Trace)
        });

        match result {
            Ok(result) => Ok(result),
            Err(TracedRunError::Run(error)) => Err(TraceSnapshotRunError::Run(error)),
            Err(TracedRunError::Trace(SnapshotTraceCallbackError::Snapshot(error))) => {
                Err(TraceSnapshotRunError::Snapshot(error))
            }
            Err(TracedRunError::Trace(SnapshotTraceCallbackError::Trace(error))) => {
                Err(TraceSnapshotRunError::Trace(error))
            }
        }
    }

    /// Runs this program and emits borrowed trace events.
    ///
    /// The callback borrows event bytes only for the duration of each call. A
    /// sink that wants to keep bytes must copy them explicitly or use
    /// [`Program::run_with_trace_snapshots`]. Runtime failures and callback
    /// failures stay separate in [`TracedRunError`], so callback control flow
    /// cannot be mistaken for interpreter failure.
    ///
    /// # Errors
    ///
    /// Returns `TracedRunError::Run` for ordinary runtime failures. Returns
    /// `TracedRunError::Trace` when the user-provided trace callback returns an
    /// error.
    pub fn run_with_borrowed_trace<'program, F, E>(
        &'program self,
        seed: RunSeed,
        trace: F,
    ) -> Result<RunResult, TracedRunError<E>>
    where
        F: for<'run> FnMut(BorrowedTraceEvent<'program, 'run>) -> Result<(), E>,
    {
        crate::execution::run_with_borrowed_trace(self, seed, trace)
    }
}