Expand description
Framework-agnostic forma and query planning primitives.
hyle deliberately has no React, DOM, async, or transport concepts.
It describes models and fields, derives backend query manifests, and resolves
raw backend sources into purified results plus lookup tables. UI frameworks should build
thin adapters on top of these serializable structures.
Structs§
- Adapter
Filters Options - Options for a filters hook (e.g.
use_filters) — framework-agnostic base. - Adapter
Form Options - Options for a form hook (e.g.
use_form) — framework-agnostic base. - Blueprint
- Column
- Field
- Field
Change - The result of a per-field
changetransform. - Field
Options - Form
Errors - Pre-rendered validation errors injected by a POST handler into the server context so that form pages can display them without JS.
- Forma
- Forma
Field - Hyle
Data Field - A single resolved field value with a pre-built display renderer.
- Hyle
Filter Field - Metadata for a single filter input, pre-computed by a filters hook.
- Input
Hint - Manifest
- Model
- Model
Result - Mutate
Input - The input passed to a mutation (create, update, or delete).
- Purifier
- Metadata-driven synchronous validator.
- Purify
Error - Query
- Reference
- Resolved
View - Output of
Blueprint::resolve_and_view. - Shape
Field - Sort
- UseForma
Options - Options for a forma hook (e.g.
use_forma).
Enums§
- Error
- Field
Type - Forma
Context - Which rendering context to use when deriving a query from a forma.
- Forma
Field Type - How a forma field type is described in a runtime forma definition. Strings correspond to primitive names or entity names (for references).
- Hyle
Data State - State returned by a data hook (e.g.
use_data). - Hyle
Manifest State - State returned by a manifest hook (e.g.
use_manifest). - Primitive
- Sort
Type
Statics§
- CSS
- The default component stylesheet for hyle UI components.
Traits§
- Sync
Rule - A synchronous custom validation rule, dispatched by name via the
"purifyAs": "<rule_name>"field metadata key.
Functions§
- apply_
view - Apply id-filter, filter_rows, sort, and pagination to
rowsaccording tomanifest. - display_
value - display_
value_ from_ outcome - Fallback display helper for when the blueprint is not available at the call
site (e.g. a table cell renderer that only holds an [
Outcome]). - filter_
rows - forma_
to_ query - Derive a
Queryfrom aFormadefinition. - is_
single - Returns
truewhen the outcome represents a single record — either because the query usedmethod: "one"or because the source returned a single row (ModelRows::One). - make_
field - Build a
Fieldby kind name. Used by the WASMmake_fieldexport so the JSfieldbuilder helpers can delegate entirely to Rust. - parse_
query_ params - Parse a URL query string into
(page, per_page, filters). - purify_
row_ sync - Convenience wrapper: validate with a default (no custom rules)
Purifier. Used by the WASM export and for simple cases that don’t need custom rules. - row_
from_ form - Convert a URL-decoded form submission (
IndexMap<String, String>) into aRow(IndexMap<String, Value>). - row_
from_ value - Extract a
Rowfrom aserde_json::Valuethat is expected to be an object.
Type Aliases§
- Field
Change Fn - A single per-field transform function (render type erased to
()). - Field
Change Map - A map of per-field transform functions keyed by field name.
- Hyle
Result - Row
- Source
- Value