miden-formatting
| Crates.io | miden-formatting |
| lib.rs | miden-formatting |
| version | 0.1.1 |
| source | src |
| created_at | 2024-03-21 23:50:35.159028 |
| updated_at | 2024-03-22 17:13:33.785653 |
| description | Versatile pretty-printing and display formatting utilities used by Miden |
| homepage | https://github.com/0xPolygonMiden/miden-formatting |
| repository | https://github.com/0xPolygonMiden/miden-formatting |
| max_upload_size | |
| id | 1182145 |
| size | 44,698 |
Bobbin Threadbare (bobbinth)
documentation
README
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