Struct LayoutPlan 

pub struct LayoutPlan { /* private fields */ }

A declarative, validated layout plan for a document.

Implementations

impl LayoutPlan

pub fn builder(doc: EureDocument) -> PlanBuilder

Start a new PlanBuilder for the given document.

pub fn auto(doc: EureDocument) -> Result<Self, PlanError>

Build a plan using the default automatic policy for every node.

pub fn sectioned(doc: EureDocument) -> Result<Self, PlanError>

Build a plan that emits maps as sections wherever possible.

pub fn flat(doc: EureDocument) -> Result<Self, PlanError>

Build a plan with no sections — maps become BindingBlock and arrays of maps become PerElement(BindingBlock).

pub fn document(&self) -> &EureDocument

Borrow the underlying document.

pub fn form_of(&self, id: NodeId) -> Option<Form>

Return the assigned Form for a non-Array node.

pub fn array_form_of(&self, id: NodeId) -> Option<ArrayForm>

Return the assigned ArrayForm for an Array node.

pub fn order_of(&self, parent: NodeId) -> Option<&[NodeId]>

Return the ordered children override for a parent, if any.

pub fn emit(self) -> SourceDocument

Emit a crate::source::SourceDocument from this plan.

Trait Implementations

impl Clone for LayoutPlan

fn clone(&self) -> LayoutPlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LayoutPlan

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

Formats the value using the given formatter.