Expand description
SheetPort manifest specification types and helpers.
This crate defines the canonical data model for Formualizer I/O (FIO) manifests, provides serde serialization/deserialization, JSON Schema metadata, and validation helpers for authoring manifests that treat spreadsheets as pure input/output functions.
Structs§
- Capabilities
- Optional capabilities block for feature gating.
- Constraints
- Constraints applied to a port or field.
- Layout
Descriptor - Manifest
- Canonical manifest representation.
- Manifest
Issue - A single manifest validation issue with a JSON Pointer-like path.
- Manifest
Meta - Manifest metadata block.
- Port
- Port definition.
- Range
Schema - Record
Field - Record
Schema - Scalar
Schema - Selector
A1 - Selector
Layout - Selector
Name - Selector
Struct Ref - Selector
Table - Spec
Version - Wrapper around semver::Version for serde compatibility.
- Table
Column - Table
Schema - Table
Selector - Selector for an Excel table. Reserved in
core-v0; requiresfull-v0profile. - Units
- Units metadata (extensible).
- Validation
Error - Aggregate validation error returned when one or more issues are detected.
- Workbook
Meta - Optional workbook descriptors. These fields are advisory hints for runtimes and may be ignored unless a runtime explicitly documents support.
Enums§
- Direction
- Port direction.
- Field
Selector - Layout
Kind - Layout resolution behavior for layout selectors.
- Layout
Termination - Profile
- Conformance profile advertised by a manifest.
- Range
Kind - Record
Kind - Schema
- Schema union.
- Selector
- Selector union.
- Shape
- Port shape.
- Table
Area - Table
Kind - Value
Type - Scalar value types.
Constants§
- CRATE_
VERSION - Version of this reference implementation crate.
- CURRENT_
SPEC_ VERSION - Current supported FIO specification version.
- SPEC_
IDENT - Constant identifier for this spec.
Functions§
- generate_
schema_ json_ pretty - Generate the JSON Schema for
Manifestusing schemars at runtime. - generate_
schema_ value - Generate the JSON Schema as a
serde_json::Value. - load_
manifest_ from_ reader - Load a manifest from any reader implementing
std::io::Read. - load_
manifest_ from_ str - Load a manifest from a YAML string slice.
- manifest_
to_ yaml - Serialize a manifest back to YAML, in a stable order.
- schema_
json - Returns the canonical JSON Schema (Draft 2019-09) for the current manifest version.