Enum LayoutItem 

pub enum LayoutItem {
    Comment(Comment),
    BlankLine,
    Binding {
        path: SourcePath,
        node: NodeId,
        trailing_comment: Option<String>,
    },
    Section {
        path: SourcePath,
        trailing_comment: Option<String>,
        body: SectionBody,
    },
    ArrayBinding {
        path: SourcePath,
        node: NodeId,
        elements: Vec<ArrayElementLayout>,
        trailing_comment: Option<String>,
    },
}

An item in the layout.

Variants

Comment(Comment)

A comment (line or block)

BlankLine

A blank line for visual separation

Binding

A key-value binding: path.to.key = <value from NodeId>

Fields

path: SourcePath

Path to the binding target

node: NodeId

Reference to the value node in EureDocument

trailing_comment: Option<String>

Optional trailing comment: key = value // comment

Section

A section header: @ path.to.section

Fields

path: SourcePath

Path to the section

trailing_comment: Option<String>

Optional trailing comment: @ section // comment

body: SectionBody

Section body

ArrayBinding

An array binding with per-element layout information.

Used when an array has comments between elements that need to be preserved.

items = [
  // First item
  "one",
  // Second item
  "two",
]

Fields

path: SourcePath

Path to the binding target

node: NodeId

Reference to the array node in EureDocument

elements: Vec<ArrayElementLayout>

Per-element layout information (comments before each element)

trailing_comment: Option<String>

Optional trailing comment

Implementations

impl LayoutItem

pub fn line_comment(s: impl Into<String>) -> Self

Create a line comment item.

pub fn block_comment(s: impl Into<String>) -> Self

Create a block comment item.

pub fn binding(path: SourcePath, node: NodeId) -> Self

Create a binding item.

pub fn binding_with_comment( path: SourcePath, node: NodeId, comment: impl Into<String>, ) -> Self

Create a binding item with trailing comment.

pub fn section(path: SourcePath, items: Vec<LayoutItem>) -> Self

Create a section item with items body.

pub fn section_block(path: SourcePath, items: Vec<LayoutItem>) -> Self

Create a section item with block body.

pub fn section_with_comment( path: SourcePath, comment: impl Into<String>, items: Vec<LayoutItem>, ) -> Self

Create a section item with trailing comment.

pub fn array_binding( path: SourcePath, node: NodeId, elements: Vec<ArrayElementLayout>, ) -> Self

Create an array binding item with per-element layout.

Trait Implementations

impl Clone for LayoutItem

fn clone(&self) -> LayoutItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LayoutItem

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

Formats the value using the given formatter.

impl PartialEq for LayoutItem

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for LayoutItem