nameof 1.0.0

Provides a Rust macro to determine the string name of a binding, type, or function.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74


nameof
======
[![Crate Version](https://img.shields.io/crates/v/nameof.svg)](https://crates.io/crates/nameof)
[![Build Status](https://travis-ci.org/SilentByte/nameof.svg?branch=master)](https://travis-ci.org/SilentByte/nameof)
[![MIT License](https://img.shields.io/badge/license-MIT%20License-blue.svg)](https://opensource.org/licenses/MIT)

The `name_of!()` macro defined in this crate takes a binding, type, or function as an argument and returns its unqualified string representation. If the identifier does not exist in the current context, the macro will cause a compilation error. This macro is mainly intended for debugging purposes and to improve the refactoring experience compared to `stringify!()`.


## Usage

Add `nameof` as a dependency to your project's `Cargo.toml` file:

```toml
[dependencies]
nameof = "*"
```

To use the macro(s), import the crate with the required annotation:

```rust
#[macro_use]
extern crate nameof;

fn main() {
    let text = "Hello, World!";
    println!("Variable `{}` holds `{}`.", name_of!(text), text);
}
```


## Examples

The `name_of!()` macro is used as follows:

```rust
#[macro_use]
extern crate nameof;

fn main() {
    // Bindings
    let text = "Hello, World!";
    println!("Variable `{}` holds `{}`.", name_of!(text), text);
    
    // Functions
    fn greet() { }
    println!("Function is called `{}`.", name_of!(greet));
    
    // Types & Fields
    struct TestStruct { test_field: i32 }
    println!("Struct is called `{}`.", name_of!(type TestStruct));
    println!("Standard Types: `{}`.", name_of!(type i32));
    println!("Field is called `{}`.", name_of!(test_field for TestStruct));
}
```

Alternatively, `name_of_type!(T)` can be used instead of `name_of!(type T)`.

```rust
#[macro_use]
extern crate nameof;

fn main() {
    struct TestStruct { test_field: i32 }
    println!("Struct is called `{}`.", name_of_type!(TestStruct));
    println!("Struct is called `{}`.", name_of_type!(i32));
}
```

## License

See [LICENSE.txt](LICENSE.txt).