rizzma 1.11.0

A Rust reimplementation of the good parts of matplotlib/pyplot, with first-class wasm support.
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
106
107
108
109
110

//! The metadata a host reads before it decides to render anything.
//!
//! These types are shared by the exporter (which writes them into the JSON
//! chunk) and by [`inspect`](super::inspect), so the two cannot drift.

use serde::{Deserialize, Serialize};

/// Provenance of the exporter.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct GeneratorRef {
    /// The rizzma crate version that wrote the artifact.
    pub rizzma: String,
}

/// The renderer an artifact was authored against.
///
/// The digest is **provenance and a lookup key, never an authorization**: an
/// artifact reporting a hash of its own bytes proves nothing, since a hostile
/// artifact can honestly report the hash of a hostile renderer. A host resolves
/// renderers through its own vetted registry; see the crate docs.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct RendererRef {
    /// rizzma version of the authoring renderer.
    pub version: String,
    /// SHA-256 of the published wasm renderer for that version, when known.
    pub sha256: Option<String>,
}

/// Where a poster lives and what it is.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct PosterRef {
    /// The chunk tag holding the poster bytes (always `"PSTR"` today).
    pub chunk: String,
    /// The poster's media type (always `"image/png"` today).
    pub mime: String,
    /// Poster length in bytes.
    pub bytes: usize,
}

/// Layout, accessibility, and fallback metadata carried in the JSON chunk.
///
/// Everything here answers a question a host has *before* fetching a renderer:
/// how much space to reserve, what to announce to a screen reader, and what to
/// show if the figure cannot be rendered at all.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Meta {
    /// Exact figure width in pixels (`width_in × dpi`), not an aspect hint, so
    /// a host reserves the right box and never reflows.
    pub width_px: u32,
    /// Exact figure height in pixels (`height_in × dpi`).
    pub height_px: u32,
    /// A text description of the figure for assistive technology and for hosts
    /// that show alt text beside a poster.
    pub alt: Option<String>,
    /// The figure's title, when it has one.
    pub title: Option<String>,
    /// The poster, when the artifact carries one.
    pub poster: Option<PosterRef>,
    /// Whether the artifact carries a timeline that animates.
    pub animated: bool,
    /// Length of the animation in seconds; `0.0` when the figure is static.
    ///
    /// A host reads this to decide whether to show transport controls, without
    /// parsing the timeline itself. Defaulted so schema 1 and 2 artifacts,
    /// which predate it, still load.
    #[serde(default)]
    pub duration: f64,
}

/// What [`inspect`](super::inspect) returns: everything readable without
/// instantiating a renderer or allocating the bulk payloads.
#[derive(Debug, Clone, PartialEq)]
pub struct Metadata {
    /// Wire-format schema version the artifact declares.
    pub schema: u32,
    /// Whether this build can render that schema (see
    /// [`SCHEMA_MIN`](super::SCHEMA_MIN)/[`SCHEMA_VERSION`](super::SCHEMA_VERSION)).
    pub schema_supported: bool,
    /// Which rizzma wrote it.
    pub generator: GeneratorRef,
    /// Which renderer it was authored against.
    pub renderer: RendererRef,
    /// Layout and fallback metadata, absent in schema 1 artifacts.
    pub meta: Option<Meta>,
    /// Every chunk in the container, in file order.
    pub chunks: Vec<super::container::ChunkRef>,
    /// Total artifact size in bytes.
    pub total_bytes: usize,
}

impl Metadata {
    /// The poster bytes, if the artifact carries a poster chunk.
    ///
    /// `bytes` must be the same slice that was inspected.
    #[must_use]
    pub fn poster<'a>(&self, bytes: &'a [u8]) -> Option<&'a [u8]> {
        super::container::chunk(bytes, &self.chunks, super::container::TAG_PSTR)
    }

    /// Whether a host can render this artifact live, or must fall back to the
    /// poster: true only when the schema is supported.
    #[must_use]
    pub fn renderable(&self) -> bool {
        self.schema_supported
    }
}