powerio 0.11.1

Compiler infrastructure for power systems: parse, validate, transform, and emit grid models
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

//! PowerIO IR serialization and deserialization.

use powerio_core::{
    ArtifactPath, Diagnostic, EmitResult, Error, Fidelity, MemoryArtifact, PioModule,
};

use crate::PioValue;

/// Serialize a diagnostics list as the JSON array of PowerIO IR diagnostic
/// records: the encoding a module's `diagnostics` field carries, with an
/// identity minted for every record that has none.
///
/// # Errors
/// The records cannot be encoded as JSON.
pub fn serialize_diagnostics(diagnostics: &[Diagnostic]) -> Result<String, Error> {
    let records = crate::stored::encode_diagnostics(diagnostics);
    serde_json::to_string(&records).map_err(|cause| {
        Error::new(
            &crate::codes::READ_MODULE_INVALID,
            format!("diagnostics could not be encoded as JSON: {cause}"),
        )
        .with_cause(cause)
    })
}

/// Generate the JSON Schema for this build's PowerIO IR document.
#[cfg(feature = "schema")]
#[must_use]
pub fn generate_ir_schema() -> schemars::Schema {
    schemars::schema_for!(crate::stored::StoredModule)
}

/// Serialize a dynamic module as PowerIO IR.
///
/// PowerIO IR is the durable representation of a complete [`PioModule`]. It
/// is separate from the grid exchange formats handled by [`crate::emit`].
///
/// # Errors
/// The module cannot be represented by the current IR schema, or the
/// destination refuses the artifact.
pub fn serialize<T>(
    module: &PioModule<T>,
    output: impl powerio_core::IntoDestination,
) -> Result<EmitResult, Error>
where
    T: Clone + Into<PioValue>,
{
    let module = module.clone().map_value(Into::into);
    let text = crate::stored::emit_module(&module)?;
    let artifact = MemoryArtifact::new(ArtifactPath::new("module.pio.json")?, text.into_bytes());
    output.into_destination()?.__commit_artifacts(
        false,
        Fidelity::Canonical,
        vec![artifact],
        Vec::new(),
    )
}

/// Deserialize one PowerIO IR input: a file name, content in memory, or a
/// [`powerio_core::Source`].
///
/// # Errors
/// The source is not one UTF-8 IR document, or its schema is unsupported or
/// invalid.
pub fn deserialize(input: impl powerio_core::IntoSource) -> Result<PioModule<PioValue>, Error> {
    let source = input.into_source()?;
    let buffer = source.primary_buffer()?;
    let text = std::str::from_utf8(buffer.content_bytes()).map_err(|cause| {
        Error::new(
            &crate::codes::READ_MODULE_INVALID,
            format!("PowerIO IR is not valid UTF-8: {cause}"),
        )
        .with_cause(cause)
        .with_source(source.clone())
    })?;
    crate::stored::read_module(text)
        .map(|module| module.with_source(source.clone()))
        .map_err(|error| error.with_source(source))
}