Skip to main content

FieldNode

Struct FieldNode 

Source
pub struct FieldNode {
Show 28 fields pub id: String, pub name: Option<String>, pub role: Option<String>, pub field_type: String, pub recto: Option<String>, pub verso: Option<String>, pub target: Option<String>, pub folio_style: Option<String>, pub suppress_first: Option<bool>, pub x: Option<PropertyValue>, pub y: Option<PropertyValue>, pub w: Option<PropertyValue>, pub h: Option<PropertyValue>, pub style: Option<String>, pub fill: Option<PropertyValue>, pub font_family: Option<PropertyValue>, pub font_size: Option<PropertyValue>, pub opacity: Option<f64>, pub visible: Option<bool>, pub locked: Option<bool>, pub anchor: Option<String>, pub anchor_zone: Option<String>, pub anchor_sibling: Option<String>, pub anchor_edge: Option<String>, pub anchor_gap: Option<Dimension>, pub anchor_parent: Option<bool>, pub source_span: Option<Span>, pub unknown_props: BTreeMap<String, UnknownProperty>,
}
Expand description

A field node — an auto-resolved text placeholder for book interiors.

A field is a LEAF that, at compile time, resolves to a single-line text run against the page it is projected onto. It is the building block of the master-page / running-head / folio system: a master declares a field once (e.g. a running head or a page-number) and every page that uses the master gets the field resolved against that page’s index and parity.

Field types (v0):

  • "running-head" → renders FieldNode::recto on odd (recto) pages and FieldNode::verso on even (verso) pages; an absent side renders nothing.
  • "page-number" → renders the page’s folio (its 1-based index in doc.body.pages) as a decimal string.
  • "page-ref" → renders the 1-based page index of the page that CONTAINS the node whose id equals FieldNode::target (document-wide search). A missing target produces an advisory field.unresolved_ref and renders nothing.

Geometry: when x/w are omitted the field defaults to the page’s live area (so a running head auto-mirrors recto/verso x via the page margins). y/h default to the live area’s top/height when omitted. The resolved run is shaped like a single-line text node: running-head / page-number default to align="center", page-ref to align="start".

Fields§

§id: String§name: Option<String>§role: Option<String>§field_type: String

The field kind string ("running-head"/"page-number"/"page-ref"). Validated, not enum-typed, so unknown values survive for forward-compat.

§recto: Option<String>

Recto-side text for a running-head field (odd, 1-based pages).

§verso: Option<String>

Verso-side text for a running-head field (even pages).

§target: Option<String>

Target node id for a page-ref field.

§folio_style: Option<String>

Folio numbering style for numeric fields (page-number, page-count, page-ref): "decimal" (default), "lower-roman", or "upper-roman". Ignored by running-head. Unknown values fall back to decimal.

§suppress_first: Option<bool>

When true, a numeric field renders nothing on document page 1 (the title page). Used to suppress the folio on the first page.

§x: Option<PropertyValue>§y: Option<PropertyValue>§w: Option<PropertyValue>§h: Option<PropertyValue>§style: Option<String>§fill: Option<PropertyValue>§font_family: Option<PropertyValue>§font_size: Option<PropertyValue>§opacity: Option<f64>§visible: Option<bool>§locked: Option<bool>§anchor: Option<String>

Page-relative placement anchor (one of the nine named positions, e.g. "bottom-right"). When present and recognized, the compile step derives the node’s x and/or y from the page and node dimensions. An explicitly- authored x or y always wins.

§anchor_zone: Option<String>

Optional safe-zone reference for the anchor. See RectNode::anchor_zone.

§anchor_sibling: Option<String>

Optional sibling node id for sibling-relative anchor positioning. See RectNode::anchor_sibling.

§anchor_edge: Option<String>

Adjacent-placement edge relative to anchor-sibling: above/below/before/after. See RectNode::anchor_edge.

§anchor_gap: Option<Dimension>

Gap (px) between this node and its anchor-sibling edge when anchor-edge is set. See RectNode::anchor_gap.

§anchor_parent: Option<bool>

Parent-relative anchor toggle. See RectNode::anchor_parent.

§source_span: Option<Span>

Source declaration span, when available.

§unknown_props: BTreeMap<String, UnknownProperty>

Unknown properties preserved for forward-compat.

Trait Implementations§

Source§

impl Clone for FieldNode

Source§

fn clone(&self) -> FieldNode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for FieldNode

Source§

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

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

impl PartialEq for FieldNode

Source§

fn eq(&self, other: &FieldNode) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for FieldNode

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.