ptr-arrow 0.1.1

A macro to emulate C-style arrow syntax
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

A macro to emulate C-style arrow syntax.

# Usage
```no_run
arrow!(my_pointer->field)
```
...which expands to:
```no_run
(*my_pointer).field
```

Arrows can be chained, and arrows and regular field accesses can be intermixed:
```no_run
arrow!(my_pointer->my_pair.0->foo)
```

Arbitrary expressions are supported:
```no_run
arrow!((if condition { some_func() } else { some_other_func() })->foo.bar()->baz)
```

# Indexing
Pointers can be indexed using the syntax `my_pointer[->index]`, where
`my_pointer` is a `*const T` or `*mut T`. Since no bounds checks can be
performed, you must ensure that the index is in bounds for the pointer.

# Method calls
If your struct has a method taking in a raw pointer as the first argument,
you can call it with a special construct:
```no_run
struct Thing { ... }
impl Thing {
	fn do_stuff(this: *mut Self, n: i32) { ... }
}

arrow!(root->my_thing->Thing::do_stuff(5));
```
...which becomes:
```no_run
Thing::do_stuff((*root).my_thing, 5)
```
This only works if a full path is specified; `arrow!(root->my_thing->do_stuff())`
will simply desugar to `(*(*root).my_thing).do_stuff()`.

# Note on precedence
The `->` operator in this macro is extremely loosely binding; all other
operators take precedence over it. `arrow!(a + b->foo)` is interpreted as
`arrow!((a + b)->foo)`. If you want to express adding `a` and `b->foo`, you
should use `a + arrow!(b->foo)`.