Expand description
Exposes the declarative runtime module.
§Examples
ⓘ
use pharos_native::runtime::declarative;§Related
crate::runtimefor sibling modules in the same crate.
Structs§
- Yaml
Compile Context - Public struct
YamlCompileContextused by this module.
Functions§
- api_
prefixed_ route_ path - Performs API prefixed route path.
- artifact_
shared_ template_ path - Resolves an app-owned artifact template without falling back to shell commands.
- build_
source_ path - Builds source path.
- compile_
yaml_ matches_ in_ directory - Compiles matching YAML files to sibling JSON artifacts without invoking a toolchain.
- declarative_
manifest_ has_ required_ fields - Validates the minimum fields required by a declarative app manifest.
- declarative_
source_ append_ generated_ route_ mut - Performs declarative source append generated route mut.
- declarative_
source_ append_ surface - Performs declarative source append surface.
- declarative_
source_ append_ unique_ string_ mut - Appends a string to an array unless the same string is already present.
- declarative_
source_ array_ has_ string - Performs declarative source array has string.
- declarative_
source_ build_ operation_ mut - Performs declarative source build operation mut.
- declarative_
source_ build_ route_ operation_ mut - Performs declarative source build route operation mut.
- declarative_
source_ build_ surface_ mut - Builds one generated surface from declarative entity, query, form, and route values.
- declarative_
source_ compile_ fixtures_ in_ directory - Performs declarative source compile fixtures in directory.
- declarative_
source_ compile_ pages_ in_ directory - Performs declarative source compile pages in directory.
- declarative_
source_ copy_ optional_ member - Performs declarative source copy optional member.
- declarative_
source_ default_ context_ binding_ mut - Performs declarative source default context binding mut.
- declarative_
source_ default_ list_ columns_ from_ form_ mut - Performs declarative source default list columns from form mut.
- declarative_
source_ default_ list_ columns_ mut - Performs declarative source default list columns mut.
- declarative_
source_ default_ path_ segment - Derives a stable generated-admin collection segment from entity metadata.
- declarative_
source_ derive_ generated_ admin_ routes - Derives missing generated-admin child routes and writes the route artifact.
- declarative_
source_ derive_ generated_ api_ routes - Derives missing generated-api mutation routes and writes the route artifact.
- declarative_
source_ derive_ generated_ surface_ fixture - Derives and writes the generated surface fixture from framework contract files.
- declarative_
source_ derived_ audit_ events_ mut - Performs declarative source derived audit events mut.
- declarative_
source_ derived_ defaults_ mut - Performs declarative source derived defaults mut.
- declarative_
source_ derived_ filters_ mut - Performs declarative source derived filters mut.
- declarative_
source_ derived_ response_ fields_ mut - Performs declarative source derived response fields mut.
- declarative_
source_ derived_ sorts_ mut - Performs declarative source derived sorts mut.
- declarative_
source_ derived_ surface_ uniqueness_ rules_ mut - Performs declarative source derived surface uniqueness rules mut.
- declarative_
source_ find_ field_ decl - Finds one form-field declaration by its field id.
- declarative_
source_ find_ generated_ form_ for_ entity - Performs declarative source find generated form for entity.
- declarative_
source_ find_ generated_ query_ for_ entity - Performs declarative source find generated query for entity.
- declarative_
source_ find_ manage_ route - Performs declarative source find manage route.
- declarative_
source_ find_ object_ by_ string_ field - Finds the first object in an array whose named field equals the expected string.
- declarative_
source_ framework_ path - Builds a safe path to one framework-owned contract file.
- declarative_
source_ has_ yaml_ fixture - Performs declarative source has YAML fixture.
- declarative_
source_ has_ yaml_ manifest - Returns whether the YAML app manifest exists at an app root.
- declarative_
source_ has_ yaml_ page - Performs declarative source has YAML page.
- declarative_
source_ identity_ param - Performs declarative source identity param.
- declarative_
source_ identity_ param_ from_ surface - Performs declarative source identity param from surface.
- declarative_
source_ label - Converts an identifier into the human-readable label used by generated surfaces.
- declarative_
source_ load_ fixture - Performs declarative source load fixture.
- declarative_
source_ load_ manifest - Loads the declarative manifest text from an app root with a bounded read.
- declarative_
source_ load_ page_ decl - Performs declarative source load page decl.
- declarative_
source_ load_ ref_ target - Loads a bounded framework contract reference such as
fields.yml#entity.fields. - declarative_
source_ operation_ path - Builds one operation path using the route contract’s colon-parameter syntax.
- declarative_
source_ option_ values_ mut - Performs declarative source option values mut.
- declarative_
source_ path_ segment_ from_ manage_ path - Converts one generated-admin path into its final resource segment.
- declarative_
source_ resolve_ dotted_ path - Resolves a dot-separated object or array path without creating intermediate values.
- declarative_
source_ route_ path_ has_ segment - Performs declarative source route path has segment.
- declarative_
source_ route_ path_ to_ surface_ path - Performs declarative source route path to surface path.
- declarative_
source_ runtime_ collection - Performs declarative source runtime collection.
- declarative_
source_ surface_ path_ to_ route_ path - Performs declarative source surface path to route path.
- default_
item_ title_ field - Returns the default item title field.
- load_
yaml_ source - Loads YAML source.
- normalize_
compiled_ json_ references - Rewrites compiled YAML references to sibling JSON artifacts in a deployment tree.
- yaml_
append_ indented_ block - Adds indentation to every line of an included YAML block.
- yaml_
buffer_ append - Appends bounded YAML source text to an output buffer.
- yaml_
compile_ add_ value - Adds a completed value to the active compile container or root.
- yaml_
compile_ context_ free - Releases a YAML compile context.
- yaml_
compile_ context_ init - Initializes a YAML compile context.
- yaml_
compile_ enabled - Reads and compiles one YAML file to JSON.
- yaml_
compile_ peek - Borrows the current compile container.
- yaml_
compile_ pop - Completes and returns the current container.
- yaml_
compile_ push - Pushes a mapping or sequence container.
- yaml_
compile_ to_ json - Compiles YAML text to one JSON value.
- yaml_
dup_ parent_ dir - Returns the parent directory of a YAML source file.
- yaml_
handle_ mapping_ end - Ends a YAML mapping container.
- yaml_
handle_ mapping_ start - Starts a YAML mapping container.
- yaml_
handle_ scalar - Adds a scalar YAML value using the same scalar rules as saphyr.
- yaml_
handle_ sequence_ end - Ends a YAML sequence container.
- yaml_
handle_ sequence_ start - Starts a YAML sequence container.
- yaml_
join_ relative_ path - Resolves a safe include path relative to a YAML source file.
- yaml_
line_ is_ fields_ include - Detects an include directive on one YAML line.
- yaml_
lookup_ include_ section_ value - Looks up a dotted section in a compiled YAML JSON value.
- yaml_
parse_ include_ token - Parses
!include relative[#section]into its two components. - yaml_
preprocess_ includes_ from_ file - Preprocesses bounded recursive YAML includes using app-relative paths.
- yaml_
read_ as_ json - Performs YAML read as JSON.
- yaml_
scalar_ is_ bool - Identifies a YAML boolean scalar.
- yaml_
scalar_ is_ float - Identifies a finite floating-point YAML scalar.
- yaml_
scalar_ is_ integer - Identifies an integer YAML scalar.
- yaml_
scalar_ is_ null - Identifies a YAML null scalar.
- yaml_
tag_ is_ bool - Identifies the YAML boolean tag.
- yaml_
tag_ is_ float - Identifies the YAML floating-point tag.
- yaml_
tag_ is_ int - Identifies the YAML integer tag.
- yaml_
tag_ is_ null - Identifies the YAML null tag.
- yaml_
tag_ is_ str - Identifies the YAML string tag.
- yaml_
token_ is_ include_ path - Identifies the supported YAML include token form.