formualizer-sheetport 0.5.5

SheetPort runtime: bind manifests to workbooks, validate IO, and run sessions deterministically
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

use crate::validation::ConstraintViolation;
use formualizer_common::ExcelError;
use formualizer_workbook::error::IoError;
use sheetport_spec::{ManifestIssue, ValidationError};
use thiserror::Error;

/// Errors produced when constructing or operating a SheetPort runtime.
#[derive(Debug, Error)]
pub enum SheetPortError {
    /// Manifest failed canonical validation.
    #[error("manifest validation failed")]
    InvalidManifest { issues: Vec<ManifestIssue> },
    /// Selector combination is not yet supported for the given port.
    #[error("unsupported selector for port `{port}`: {reason}")]
    UnsupportedSelector { port: String, reason: String },
    /// Reference string could not be parsed.
    #[error("invalid reference `{reference}` in port `{port}`: {details}")]
    InvalidReference {
        port: String,
        reference: String,
        details: String,
    },
    /// Referenced sheet was not present in the workbook.
    #[error("sheet `{sheet}` referenced by port `{port}` was not found in the workbook")]
    MissingSheet { port: String, sheet: String },
    /// Structural invariant could not be satisfied.
    #[error("invariant violation for port `{port}`: {message}")]
    InvariantViolation { port: String, message: String },
    /// Input or resolved data violated manifest constraints.
    #[error("value did not satisfy manifest constraints")]
    ConstraintViolation {
        violations: Vec<ConstraintViolation>,
    },
    /// Underlying engine reported an evaluation error.
    #[error("engine error: {source}")]
    Engine {
        #[from]
        source: ExcelError,
    },
    /// Failure when interacting with the underlying workbook backend.
    #[error("workbook error: {source}")]
    Workbook {
        #[from]
        source: IoError,
    },
}

impl From<ValidationError> for SheetPortError {
    fn from(err: ValidationError) -> Self {
        SheetPortError::InvalidManifest {
            issues: err.issues().to_vec(),
        }
    }
}