Skip to main content

SchemaSub

Enum SchemaSub 

Source
pub enum SchemaSub {
Show 13 variants Nodes, Node { kind: String, }, Ops, Op { name: String, }, Page, Asset, Document, Tokens, Token { ty: String, }, Variant, Diagnostics, Brand, Block,
}
Expand description

Subcommands of zenith schema.

Variants§

§

Nodes

List all authorable node kinds with their one-line summaries.

§

Node

Show the summary and recognized attributes for one node kind.

Fields

§kind: String

The node kind to look up (e.g. rect, text, pattern).

§

Ops

List all transaction ops with their one-line summaries.

§

Op

Show the summary, JSON fields, and a working example for one transaction op.

Fields

§name: String

The op name to look up (e.g. set_fill, add_node).

§

Page

Show the recognized attributes for a page declaration.

Lists every attribute the parser recognises on a page node: geometry (w, h), margins, bleed, baseline-grid, line-jumps, parity, and master.

§

Asset

Show the recognized attributes for an asset declaration.

Lists every attribute the parser recognises on an asset node inside the assets { … } block: id, kind, src, sha256, and the full suite of AI-provenance fields (ai-prompt, ai-model, ai-provider, …).

§

Document

Show the recognized attributes for the document root (zenith node).

Lists every attribute the parser recognises on the top-level zenith node and the document { … } child block: version, colorspace, doc-id, mirror-margins, page-progression, spread-gutter, margin-*, and more.

§

Tokens

List all authorable token types with their one-line summaries.

Shows every recognized type= value for a token node (color, dimension, fontFamily, fontWeight, gradient, shadow, filter, mask, number) with a one-line description. Use zenith schema token <type> for the full value form, child-node structure, and a working example.

§

Token

Show the value form, child-node structure, and a working example for one token type.

Describes exactly what to write for a given type= value: whether the token takes an inline value= literal (color, dimension, number, fontFamily, fontWeight) or is defined by child nodes (gradient, shadow, filter, mask), including the exact syntax for each.

Fields

§ty: String

The token type to look up (e.g. color, gradient, shadow).

§

Variant

Show the structure of the variants block and the override entry.

Documents the variants { variant id=… source=<page-id> w=(px)N h=(px)N { … } } block structure, the override node="<id>" … entry, and its recognised properties: node (required, the target node id selector — NOT id), visible (#true/#false), text (string), fill (token ref or color), and geometry x/y/w/h (typed dimensions, e.g. (px)100). Includes a concrete worked example.

§

Diagnostics

Show the in-file diagnostic-policy verbs and the governable diagnostic codes.

Lists the three policy verbs (allow, deny, warn) usable inside a root diagnostics { … } block, what each does, the precedence note (in-file policy now; CLI flags/config resolve in a later unit), and the full list of governable diagnostic codes (code · severity · summary). Integrity Errors are listed as non-suppressible.

§

Brand

Show the structure and semantics of the top-level brand { … } block.

Documents the three optional child nodes (colors, fonts, weights), placement (top-level sibling of tokens/assets/document inside zenith version=1 { … }), the absent-child = unconstrained rule, and the three diagnostic codes emitted when resolved token values fall outside the declared contract (brand.color_off_palette, brand.font_not_allowed, brand.weight_not_allowed). Shows how to elevate these Warnings to blocking Errors for a CI gate via --deny or an in-file diagnostics policy. Includes a complete worked example.

§

Block

Show the block role="…" declaration: role vocabulary, properties, scopes, and cascade.

Documents the block leaf declaration that maps a markdown block role (h1–h6, p, blockquote, li, code-block, hr) to style and spacing overrides. Declarable at three scopes: document body, page, and text node. The cascade precedence is text > page > document (highest specificity wins). Block decls are consumed only on text nodes with format="markdown".

Trait Implementations§

Source§

impl Debug for SchemaSub

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl FromArgMatches for SchemaSub

Source§

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

impl Subcommand for SchemaSub

Source§

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut Read more
Source§

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Finish for T

Source§

fn finish(self)

Does nothing but move self, equivalent to drop.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<U, T> ToOwnedObj<U> for T
where U: FromObjRef<T>,

Source§

fn to_owned_obj(&self, data: FontData<'_>) -> U

Convert this type into T, using the provided data to resolve any offsets.
Source§

impl<U, T> ToOwnedTable<U> for T
where U: FromTableRef<T>,

Source§

fn to_owned_table(&self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.