Skip to main content

CodeNode

Struct CodeNode 

Source
pub struct CodeNode {
Show 31 fields pub id: String, pub name: Option<String>, pub role: Option<String>, pub x: Option<PropertyValue>, pub y: Option<PropertyValue>, pub w: Option<PropertyValue>, pub h: Option<PropertyValue>, pub overflow: Option<String>, pub language: Option<String>, pub line_numbers: Option<bool>, pub tab_width: Option<u32>, pub style: Option<String>, pub fill: Option<PropertyValue>, pub font_family: Option<PropertyValue>, pub font_size: Option<PropertyValue>, pub font_weight: Option<PropertyValue>, pub syntax_theme: Option<SyntaxTheme>, pub opacity: Option<f64>, pub visible: Option<bool>, pub locked: Option<bool>, pub selectable: Option<bool>, pub rotate: Option<Dimension>, pub content: String, 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 code node — a multi-line MONOSPACE text block.

Structurally this mirrors TextNode but carries a single verbatim source blob instead of styled spans. The blob is stored DECODED (newlines and tabs are literal characters); the formatter re-encodes it with escapes.

The verbatim source is carried in the KDL as a content child node with one escaped string argument (NOT a bare r#"..."# raw string): KDL v2 multi-line string dedent semantics make the raw form lossy, whereas a single-line escaped string round-trips \n \t \" \\ exactly through the kdl crate. See transform_code / write_code for the parse/format sides.

Fields§

§id: String§name: Option<String>§role: Option<String>§x: Option<PropertyValue>§y: Option<PropertyValue>§w: Option<PropertyValue>§h: Option<PropertyValue>§overflow: Option<String>

“clip” (default) or “visible”; v0 does not word-wrap.

§language: Option<String>

Open string naming the source language; drives built-in syntax highlighting when the language is supported, otherwise renders as plain text.

§line_numbers: Option<bool>

Render a line-number gutter (default false).

§tab_width: Option<u32>

Rendered column width of a tab (default 4).

§style: Option<String>§fill: Option<PropertyValue>§font_family: Option<PropertyValue>§font_size: Option<PropertyValue>§font_weight: Option<PropertyValue>

Numeric font weight (100–900), usually a fontWeight token ref.

§syntax_theme: Option<SyntaxTheme>

Optional built-in syntax-highlight color theme; None = use default (Dark).

§opacity: Option<f64>§visible: Option<bool>§locked: Option<bool>§selectable: Option<bool>

PDF text-extraction toggle (see TextNode::selectable). None/ Some(true) (default) → real selectable/searchable text; Some(false) → filled glyph outlines (visually identical, not extractable). PDF-only.

§rotate: Option<Dimension>§content: String

Verbatim source text (decoded; newlines/tabs are literal characters).

§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 CodeNode

Source§

fn clone(&self) -> CodeNode

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 CodeNode

Source§

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

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

impl PartialEq for CodeNode

Source§

fn eq(&self, other: &CodeNode) -> 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 CodeNode

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.