paste

Macros for all your token pasting needs

(This project is no longer maintained.)

The nightly-only concat_idents! macro in the Rust standard library is notoriously underpowered in that its concatenated identifiers can only refer to existing items, they can never be used to define something new.

This crate provides a flexible way to paste together identifiers in a macro, including using pasted identifiers to define new items.

[dependencies]
paste = "1.0"

This approach works with any Rust compiler 1.31+.

Pasting identifiers

Within the paste! macro, identifiers inside [] are pasted together to form a single identifier.

use paste::paste;

paste! {
    // Defines a const called `QRST`.
    const []: &str = "success!";
}

fn main() {
    assert_eq!(
        paste! { [].len() },
        8,
    );
}

More elaborate example

The next example shows a macro that generates accessor methods for some struct fields. It demonstrates how you might find it useful to bundle a paste invocation inside of a macro_rules macro.

…

Case conversion

Use $var:lower or $var:upper in the segment list to convert an interpolated segment to lower- or uppercase as part of the paste. For example, [] would paste to ld_bc_expr if invoked with $reg=Bc.

Use $var:snake to convert CamelCase input to snake_case. Use $var:camel to convert snake_case to CamelCase. These compose, so for example $var:snake:upper would give you SCREAMING_CASE.

The precise Unicode conversions are as defined by str::to_lowercase and str::to_uppercase.

Pasting documentation strings

Within the paste! macro, arguments to a #[doc ...] attribute are implicitly concatenated together to form a coherent documentation string.

use paste::paste;

macro_rules! method_new {
    ($ret:ident) => {
        paste! {
            #[doc = "Create a new `" $ret "` object."]
            pub fn new() -> $ret { todo!() }
        }
    };
}

pub struct Paste {}

method_new!(Paste);  // expands to #[doc = "Create a new `Paste` object"]

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.

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