How do I enable hyphenation in Textwrap?

Enable the 'hyphenation' Cargo feature, load the hyphenation patterns (e.g., using the hyphenation crate), and set Options::word_splitter to WordSplitter::Hyphenation. This adds about 88 KB for US-English patterns, as noted in the documentation.

Textwrap vs other Rust text wrapping libraries like wrap-rs?

Textwrap offers advanced features like optimal-fit algorithms and hyphenation support, making it better for balanced text, while wrap-rs might be simpler for basic needs. Textwrap's configurability comes at the cost of more complex setup and optional dependencies.

Does Textwrap support right-to-left languages?

The README doesn't mention explicit support for right-to-left languages; it focuses on Unicode handling and hyphenation for left-to-right scripts. Developers might need additional libraries for bidirectional text layout.

How can I reduce binary size when using Textwrap?

Disable default features like Unicode support via Cargo.toml and only enable necessary ones (e.g., skip 'hyphenation' if not needed). This modular design helps minimize size, as explained in the crate documentation.

Can I use Textwrap in WebAssembly projects?

Yes, Textwrap supports WebAssembly for text wrapping on HTML5 canvases, as shown in the wasm demo. Ensure you enable relevant features and handle proportional fonts appropriately for rendering.

What's the difference between wrap and fill functions?

Wrap returns a vector of lines as strings, while fill returns a single string with newlines inserted. Both use the same underlying algorithm, but fill is convenient for direct output, as illustrated in the getting started examples.

Open-Awesome

textwrap

MITRust0.16.2

A Rust library for wrapping and indenting text with optimal-fit algorithms and hyphenation support.

GitHub

523 stars53 forks0 contributors

What is textwrap?

Textwrap is a Rust library for wrapping and indenting text, designed to format dynamic output for command-line programs and other applications like PDF generation or WebAssembly-based rendering. It solves the problem of making text fit within specified widths while maintaining readability and aesthetic balance.

Target Audience

Rust developers building command-line tools, terminal applications, or systems that generate formatted text output, such as PDFs or canvas-based UIs.

Value Proposition

Developers choose Textwrap for its efficient optimal-fit algorithm, support for Unicode and hyphenation, and modular design that allows them to pay only for the features they use, keeping binaries small.

Overview

An efficient and powerful Rust library for word wrapping text.

Use Cases

Best For

Formatting command-line program output for terminal display
Wrapping text in proportional fonts for PDF generation
Rendering wrapped text on HTML5 canvases using WebAssembly
Applications requiring multilingual hyphenation support
Optimizing text layout with minimal gaps at line ends
Reducing binary size by enabling only necessary text-wrapping features

Not Ideal For

Applications requiring rich text formatting with styles, colors, or multiple fonts
Projects with extremely tight binary size constraints where even optional features are prohibitive
Real-time GUI applications needing frequent, dynamic text reflow with minimal latency

Pros & Cons

Pros

Optimal-Fit Algorithm

Uses look-ahead to minimize gaps at line ends for balanced text, as demonstrated with the 'smawk' feature enabling smarter line breaks compared to basic wrapping.

Configurable and Modular

Offers customizable wrap algorithms and word splitters via the Options struct, and allows enabling only necessary features to keep binaries lean, as highlighted in the Cargo features documentation.

Unicode and Hyphenation Support

Handles Unicode strings by default and supports hyphenation for about 70 languages using high-quality TeX patterns via an optional feature, though it adds binary size.

Compile-Time Wrapping

Provides procedural macros through the textwrap-macros crate for wrapping strings known at compile time, improving performance for static text.

Cons

Binary Size Overhead

Enabling features like hyphenation significantly increases binary size (e.g., 88 KB for US-English patterns), which can be a drawback for resource-constrained environments.

Platform Limitations

The interactive demo, key for feature exploration, only works on Linux terminals, limiting usability for developers on Windows or macOS.

Complex Advanced Setup

Hyphenation requires loading external patterns and configuring WordSplitter, adding steps and potential dependency management issues compared to basic usage.

Frequently Asked Questions

Related Projects

ripgrep-all

rga: ripgrep, but also search in PDFs, E-Books, Office documents, zip, tar.gz, etc.

Stars9,765

Forks216

Last commit4 months ago

Kreuzberg

A polyglot document intelligence framework with a Rust core. Extract text, metadata, images, and structured information from PDFs, Office documents, images, and 97+ formats. Available for Rust, Python, Ruby, Java, Go, PHP, Elixir, C#, R, C, TypeScript (Node/Bun/Wasm/Deno)- or use via CLI, REST API, or MCP server.

Stars8,691

Forks526

Last commit17 hours ago

grex

A command-line tool and Rust library with Python bindings for generating regular expressions from user-provided test cases

Stars8,161

Forks196