Skip to content
Macros for all your token pasting needs
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
impl Switch to SPDX 2.1 license expression May 9, 2019
src Update to 2018 edition Apr 30, 2019
tests Update to 2018 edition Apr 30, 2019
.gitignore Token pasting macros Nov 1, 2018
.travis.yml Update to 2018 edition Apr 30, 2019
Cargo.toml Switch to SPDX 2.1 license expression May 9, 2019
LICENSE-APACHE Token pasting macros Nov 1, 2018
LICENSE-MIT Token pasting macros Nov 1, 2018
README.md Update to 2018 edition Apr 30, 2019

README.md

Macros for all your token pasting needs

Build Status Latest Version Rust Documentation

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 = "0.1"

This approach works with any stable or nightly Rust compiler 1.30+.

Pasting identifiers

There are two entry points, paste::expr! for macros in expression position and paste::item! for macros in item position.

Within either one, identifiers inside [<...>] are pasted together to form a single identifier.

// Macro in item position: at module scope or inside of an impl block.
paste::item! {
    // Defines a const called `QRST`.
    const [<Q R S T>]: &str = "success!";
}

fn main() {
    // Macro in expression position: inside a function body.
    assert_eq!(
        paste::expr! { [<Q R S T>].len() },
        8,
    );
}

More elaborate examples

This program demonstrates how you may want to bundle a paste invocation inside of a more convenient user-facing macro of your own. Here the routes!(A, B) macro expands to a vector containing ROUTE_A and ROUTE_B.

const ROUTE_A: &str = "/a";
const ROUTE_B: &str = "/b";

macro_rules! routes {
    ($($route:ident),*) => {{
        paste::expr! {
            vec![$( [<ROUTE_ $route>] ),*]
        }
    }}
}

fn main() {
    let routes = routes!(A, B);
    assert_eq!(routes, vec!["/a", "/b"]);
}

The next example shows a macro that generates accessor methods for some struct fields.

macro_rules! make_a_struct_and_getters {
    ($name:ident { $($field:ident),* }) => {
        // Define a struct. This expands to:
        //
        //     pub struct S {
        //         a: String,
        //         b: String,
        //         c: String,
        //     }
        pub struct $name {
            $(
                $field: String,
            )*
        }

        // Build an impl block with getters. This expands to:
        //
        //     impl S {
        //         pub fn get_a(&self) -> &str { &self.a }
        //         pub fn get_b(&self) -> &str { &self.b }
        //         pub fn get_c(&self) -> &str { &self.c }
        //     }
        paste::item! {
            impl $name {
                $(
                    pub fn [<get_ $field>](&self) -> &str {
                        &self.$field
                    }
                )*
            }
        }
    }
}

make_a_struct_and_getters!(S { a, b, c });

fn call_some_getters(s: &S) -> bool {
    s.get_a() == s.get_b() && s.get_c().is_empty()
}

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.
You can’t perform that action at this time.