syn-locator 0.1.2

A simple source code locator for syn crate
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

# syn-locator

syn-locator helps you to find source code locations of
[syn](https://crates.io/crates/syn) nodes.

## When to use

If you read a rust file then parse the read string through the `syn::parse_str`,
you will lose span information. This crate finds source code locations of syntax
tree nodes by simple string comparison.

## Example

```rust
use syn_locator::*;

// Assumes that we read this code from a file.
let file_path = "/path/to/file.rs";
let code = "
    struct Foo {
        a: i32,
    }
";
let syn = syn::parse_str::<syn::File>(code).unwrap();

// Finds location of the syntax tree.
let syn = std::pin::Pin::new(&syn);
syn.locate_as_entry(file_path, code);

// Picks a syntax tree node.
let item_struct = match &syn.items[0] {
    syn::Item::Struct(item_struct) => item_struct,
    _ => unreachable!()
};
let field_ty = &item_struct.fields.iter().next().unwrap().ty;

// Let's find out 'i32' from the syntax tree node.
assert_eq!(field_ty.location_message(), "/path/to/file.rs:3: i32");
assert_eq!(field_ty.location(), Location {
    file_path,
    start: 29, // Byte offset
    end: 32
});
```