vize_l0 0.429.2

L0 - the Davinci foundation level: ids, side tables, keys, dumps, diagnostics, passes and facts
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

//! The textual dump contract: every level artifact prints and parses back.
//!
//! Dumps exist for `vize dump` and observers; they are never a transport
//! between levels.
#![expect(clippy::todo, reason = "skeleton: #6833")]

use alloc::boxed::Box;
use core::fmt;

pub mod capture;
pub mod runtime;
pub mod value;

pub use runtime::{DumpPage, DumpRuntime};
pub use value::DumpValue;

/// Which form [`Dump::print`] renders.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DumpMode {
    /// Canonical text that [`Dump::parse`] reads back.
    Full,
    /// Human-oriented text; never parsed.
    Display,
}

/// A parse failure with its 1-based line.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct DumpError {
    /// 1-based line of the failure.
    pub line: usize,
    /// What went wrong.
    pub message: Box<str>,
}

impl fmt::Display for DumpError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let _ = f;
        todo!()
    }
}

impl core::error::Error for DumpError {}

/// A level artifact that can be dumped as text and read back.
///
/// `print` in [`DumpMode::Full`] and `parse` form a round-trip pair.
pub trait Dump: Sized {
    /// Render into `w` in `mode`.
    fn print<W: fmt::Write>(&self, w: &mut W, mode: DumpMode) -> fmt::Result;

    /// Parse canonical `Full` text back into a value.
    fn parse(input: &str) -> Result<Self, DumpError>;
}