unquote

Lib.rs Crates.io Docs.rs

Rust 1.45.0 Build Status Crates.io - License

GitHub open issues open pull requests crev reviews

A reverse quote macro... that is: A macro to parse input from a [ParseStream] according to a given pattern.

Note: This library is as work in progress. While I don't expect large breaking changes to the syntax, there are missing features and error messages aren't always great yet.

This macro currently requires syn to be available in the current namespace with at least the "parsing" feature enabled. This should get fixed with the next larger refactor.

Installation

Please use cargo-edit to always add the latest version of this library:

cmd cargo add unquote

Example

```rust use call2forsyn::call2; use quote::quote; use syn::{LitStr, parse::ParseStream, Result}; use unquote::unquote;

fn main() -> Result<()> {

// Sample input let tokens = quote!();

// Analogous to a parser implementation with syn: fn parser_function(input: ParseStream) -> Result { // Declare bindings ahead of time. // Rust can usually infer the type. let parsed;

// This uses the ? operator internally - // It needs to be inside a Result-returning function. unquote!(input, );

Ok(parsed) }

let parsed = call2(tokens, parserfunction)?; asserteq!(parsed.value(), "Hello!");

Ok(())

}

```

Implementation Status

(roughly in order of priority)

| Tokens | | |-|-| | Punct | ✔³ | | Ident | | | Literal | |

| Bindings | | |-|-| | #binding | ✔ | | ##-escapes | |

| Groups | | |-|-| | () | | | {} | | | [] | |

| Variadics¹ | | |-|-| | #(#binding)? | | | #(#binding)* | | | #(#binding),* | | | #(#binding)+² | | | #(#binding),+² | |

| Bound Groups | | |-|-| | #binding@() | | | #binding@{} | | | #binding@[] | | | #@-escapes | |

| Bound Compounds | | |-|-| | #binding: Struct@() | | | #binding: Struct@{} | | | #binding: Struct@[] | | | #:-escapes | |

¹ Note that all variadics are eager beyond the first [TokenTree] and only do very shallow speculative parsing! In practice, this means that for example parsing ++ as #(+-)?++ will fail, as the first + "locks in" the optional phrase.

² Not specifically present in [quote], but [required variadics are great.]

³ Currently without distinction regarding combinations like => vs. = > and such. This will change eventually, along with a breaking semver change.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Code of Conduct

Changelog

Versioning

unquote strictly follows Semantic Versioning 2.0.0 with the following exceptions:

This includes the Rust version requirement specified above.
Earlier Rust versions may be compatible, but this can change with minor or patch releases.

Which versions are affected by features and patches can be determined from the respective headings in CHANGELOG.md.