Crate miden_formatting

miden-formatting

This crate provides some general infrastructure for pretty-printers and value foramtting that is needed by various Miden crates. Rather than implement this stuff in every place where it is needed, we’ve extracted the most important and general bits and put them in this crate.

Usage

Add miden-formatting to your Cargo.toml:

[dependencies]
miden-formatting = "0.1"

For #![no_std] builds:

[dependencies]
miden-formatting = { version = "0.1", default-features = false }

There is a std feature you can use to conditionally enable functionality that requires libstd to implement. For now this features is not actually needed, but is likely to be used in the future, so we’re providing it now.

Intro

Most likely you are pulling in this crate to make use of the pretty-printer infrastructure. See the documentation for the PrettyPrint trait for a comprehensive intro to how to get started with it.

You may also be interested in the example syntax tree defined here. This makes use of most features of the pretty printer in a small made-up language for learning.

License

This project is MIT licensed

Modules

• hex
  This module provides various utilties for formatting values as hexadecimal bytes.
• prettier
  This module provides a generic pretty printer implementation of the “Prettier” variety, i.e. based on the design described by Philip Wadler in A prettier printer.

Macros

• pretty_via_display
  Generate an implementation of PrettyPrint for a given type by delegating to core::fmt::Display.
• pretty_via_to_string
  Generate an implementation of PrettyPrint for a given type by delegating to alloc::string::ToString.