Crate shuck_format 

Generic document and pretty-printing primitives used by shuck-formatter.

This crate is shell-agnostic. It provides the document tree, formatter traits, and printer implementation that higher-level crates use to build language-specific formatting rules.

Modules

prelude

Re-exports commonly used when implementing crate::Format values.

Macros

format

write

Structs

Document

Formatting document elements and document construction helpers.

FormatError

Core formatter traits, options, and formatted output wrappers.

Formatted

Core formatter traits, options, and formatted output wrappers.

Formatter

Core formatter traits, options, and formatted output wrappers.

PrintError

Printer configuration and rendered output types.

Printed

Printer configuration and rendered output types.

Printer

Printer configuration and rendered output types.

PrinterOptions

Printer configuration and rendered output types.

SimpleFormatContext

Core formatter traits, options, and formatted output wrappers.

SimpleFormatOptions

Core formatter traits, options, and formatted output wrappers.

VecBuffer

Output buffers used while constructing format documents.

Enums

FormatElement

Formatting document elements and document construction helpers.

IndentStyle

Printer configuration and rendered output types.

LineEnding

Printer configuration and rendered output types.

LineMode

Formatting document elements and document construction helpers.

Traits

Buffer

Output buffers used while constructing format documents.

Format

Core formatter traits, options, and formatted output wrappers.

FormatContext

Core formatter traits, options, and formatted output wrappers.

FormatOptions

Core formatter traits, options, and formatted output wrappers.

Functions

best_fit

Formatting document elements and document construction helpers.

group

Formatting document elements and document construction helpers.

hard_line_break

Formatting document elements and document construction helpers.

indent

Formatting document elements and document construction helpers.

soft_line_break

Formatting document elements and document construction helpers.

soft_line_break_or_space

Formatting document elements and document construction helpers.

space

Formatting document elements and document construction helpers.

text

Formatting document elements and document construction helpers.

token

Formatting document elements and document construction helpers.

verbatim

Formatting document elements and document construction helpers.

Type Aliases

FormatResult

Core formatter traits, options, and formatted output wrappers.