diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 28 |
1 files changed, 17 insertions, 11 deletions
@@ -1,23 +1,24 @@ # syn-mid -[![crates.io](https://img.shields.io/crates/v/syn-mid.svg?style=flat-square&logo=rust)](https://crates.io/crates/syn-mid) -[![docs.rs](https://img.shields.io/badge/docs.rs-syn--mid-blue?style=flat-square)](https://docs.rs/syn-mid) -[![license](https://img.shields.io/badge/license-Apache--2.0_OR_MIT-blue.svg?style=flat-square)](#license) -[![rustc](https://img.shields.io/badge/rustc-1.31+-blue.svg?style=flat-square)](https://www.rust-lang.org) -[![build status](https://img.shields.io/github/workflow/status/taiki-e/syn-mid/CI/master?style=flat-square)](https://github.com/taiki-e/syn-mid/actions?query=workflow%3ACI+branch%3Amaster) +[![crates.io](https://img.shields.io/crates/v/syn-mid?style=flat-square&logo=rust)](https://crates.io/crates/syn-mid) +[![docs.rs](https://img.shields.io/badge/docs.rs-syn--mid-blue?style=flat-square&logo=docs.rs)](https://docs.rs/syn-mid) +[![license](https://img.shields.io/badge/license-Apache--2.0_OR_MIT-blue?style=flat-square)](#license) +[![rustc](https://img.shields.io/badge/rustc-1.56+-blue?style=flat-square&logo=rust)](https://www.rust-lang.org) +[![build status](https://img.shields.io/github/actions/workflow/status/taiki-e/syn-mid/ci.yml?branch=main&style=flat-square&logo=github)](https://github.com/taiki-e/syn-mid/actions) +<!-- tidy:crate-doc:start --> Providing the features between "full" and "derive" of syn. This crate provides the following two unique data structures. -- `syn_mid::ItemFn` -- A function whose body is not parsed. +- [`syn_mid::ItemFn`] -- A function whose body is not parsed. ```text fn process(n: usize) -> Result<()> { ... } ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^ ^ ``` -- `syn_mid::Block` -- A block whose body is not parsed. +- [`syn_mid::Block`] -- A block whose body is not parsed. ```text { ... } @@ -28,8 +29,6 @@ Other data structures are the same as data structures of [syn]. These are defined in this crate because they cannot be used in [syn] without "full" feature. -[syn]: https://github.com/dtolnay/syn - ## Usage Add this to your `Cargo.toml`: @@ -39,14 +38,21 @@ Add this to your `Cargo.toml`: syn-mid = "0.5" ``` -*Compiler support: requires rustc 1.31+* +*Compiler support: requires rustc 1.56+* -[**Examples**](examples) +[**Examples**](https://github.com/taiki-e/syn-mid/tree/HEAD/examples) ## Optional features - **`clone-impls`** — Clone impls for all syntax tree types. +[syn]: https://github.com/dtolnay/syn + +<!-- tidy:crate-doc:end --> + +[`syn_mid::Block`]: https://docs.rs/syn-mid/latest/syn_mid/struct.Block.html +[`syn_mid::ItemFn`]: https://docs.rs/syn-mid/latest/syn_mid/struct.ItemFn.html + ## License Licensed under either of [Apache License, Version 2.0](LICENSE-APACHE) or |