Enum FormatElement 

pub enum FormatElement {
    Space,
    Line(LineMode),
    ExpandParent,
    SourcePosition(TextSize),
    Token {
        text: &'static str,
    },
    Text {
        text: Box<str>,
        text_width: TextWidth,
    },
    SourceCodeSlice {
        slice: SourceCodeSlice,
        text_width: TextWidth,
    },
    LineSuffixBoundary,
    Interned(Interned),
    BestFitting {
        variants: BestFittingVariants,
        mode: BestFittingMode,
    },
    Tag(Tag),
}

Language agnostic IR for formatting source code.

Use the helper functions like crate::builders::space, crate::builders::soft_line_break etc. defined in this file to create elements.

Variants

Space

A space token, see crate::builders::space for documentation.

Line(LineMode)

A new line, see crate::builders::soft_line_break, crate::builders::hard_line_break, and crate::builders::soft_line_break_or_space for documentation.

ExpandParent

Forces the parent group to print in expanded mode.

SourcePosition(TextSize)

Indicates the position of the elements coming after this element in the source document. The printer will create a source map entry from this position in the source document to the formatted position.

Token

A ASCII only Token that contains no line breaks or tab characters.

Fields

text: &'static str

Text

An arbitrary text that can contain tabs, newlines, and unicode characters.

Fields

text: Box<str>

There’s no need for the text to be mutable, using Box<str> safes 8 bytes over String.

text_width: TextWidth

SourceCodeSlice

Text that gets emitted as it is in the source code. Optimized to avoid any allocations.

Fields

slice: SourceCodeSlice

text_width: TextWidth

LineSuffixBoundary

Prevents that line suffixes move past this boundary. Forces the printer to print any pending line suffixes, potentially by inserting a hard line break.

Interned(Interned)

An interned format element. Useful when the same content must be emitted multiple times to avoid deep cloning the IR when using the best_fitting! macro or if_group_fits_on_line and if_group_breaks.

BestFitting

A list of different variants representing the same content. The printer picks the best fitting content. Line breaks inside of a best fitting don’t propagate to parent groups.

Fields

variants: BestFittingVariants

mode: BestFittingMode

Tag(Tag)

A Tag that marks the start/end of some content to which some special formatting is applied.

Implementations

impl FormatElement

pub const fn is_tag(&self) -> bool

Returns true if self is a FormatElement::Tag

pub const fn is_start_tag(&self) -> bool

Returns true if self is a FormatElement::Tag and Tag::is_start is true.

Trait Implementations

impl Clone for FormatElement

fn clone(&self) -> FormatElement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FormatElement

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

Formats the value using the given formatter.

impl Eq for FormatElement

impl FormatElements for FormatElement

fn will_break(&self) -> bool

Returns true if this FormatElement is guaranteed to break across multiple lines by the printer. This is the case if this format element recursively contains a:

fn has_label(&self, label_id: LabelId) -> bool

Returns true if the element has the given label.

fn start_tag(&self, _: TagKind) -> Option<&Tag>

Returns the start tag of kind if:

fn end_tag(&self, kind: TagKind) -> Option<&Tag>

Returns the end tag if:

impl PartialEq for FormatElement

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FormatElement