overpass-lib 0.1.0

Easily create and execute Overpass API queries of OpenStreetMap. Supports both declarative and builder syntax for generating OverpassQL strings, a reqwest-based submission API, and type definitions for handling the query results.
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

# overpass-lib


Easily create and execute [Overpass API](https://wiki.openstreetmap.org/wiki/Overpass_API)
queries of [OpenStreetMap](https://wiki.openstreetmap.org/wiki/About_OpenStreetMap). Supports
both declarative and builder syntax for generating OverpassQL strings, a [reqwest]-based
submission API, and type definitions for handling the query results.

## Usage

Just like in OverpassQL, you specify a [Set] of [Element]s that you want, defined either as a basic [FilterSet]
or as compositions of other sets (e.g. [UnionSet]). You can either define these structs directly, or use
[SetBuilder] for more convenient syntax.

Once your set is specified, you:

1. Convert it to a [Query] or [QueryBuilder],
1. Apply any top-level settings to the query (e.g. [Query::search_bbox]),
1. Evaluate the query via an Overpass API server ([OverpassServer]),
1. Do whatever you like with the [Element]s returned!


## Examples

```rust
// Let's find all the landmarks in downtown Seattle in a standard OverpassQL string.
let oql = [
    "[bbox:47.553,-122.461,47.667,-122.201][out:json];",
    r#"nw["seamark:type"="landmark"];"#,
    "out;",
].join("");

// Using the declarative syntax, it looks like this:
let dec_query = Query {
    set: FilterSet {
        filter_type: FilterType::NodeOrWay,
        tag_filters: HashSet::from([TagFilter::equals("seamark:type", "landmark")]),
        ..Default::default()
    }.into(),
    search_bbox: Some(Bbox {
        north: 47.667,
        south: 47.553,
        east: -122.201,
        west: -122.461,
    }),
    ..Default::default()
};
assert_eq!(&oql, &dec_query.to_oql());

// Using the builder API it looks like this:
let builder_query: Query = SetBuilder::all_nodes_or_ways()
    .with_tag_value("seamark:type", "landmark")
    .to_query()
    .search_bbox(Bbox {
        north: 47.667,
        south: 47.553,
        east: -122.201,
        west: -122.461,
    })
    .into();
assert_eq!(&oql, &builder_query.to_oql());

// Evaluate the query via the default Overpass API server
let res = OverpassServer::default().evaluate(&dec_query).await.unwrap();

// One of those landmarks should be the Space Needle.
assert!(res.elements.iter().any(|e| matches!(e.tag("name"), Some("Space Needle"))));
```

## Language Support

* Settings
    * ✅ timeout
    * ✅ maxsize
    * ✅ bbox
    * ✅ date
    * ✅ diff
    * ❌ adiff
    * ❌ out count
    * ✅ out verbosity
    * ❌ out modificators
    * ❌ out bbox
    * ❌ out sort order
    * ❌ out limit
* Sets
    * ✅ union
    * ❌ difference
    * ✅ intersection
    * ❌ if-block
    * ❌ foreach
    * ❌ for
    * ❌ complete
    * ❌ retro
    * ❌ compare
    * ❌ recurse up
    * ❌ recurse up relations
    * ❌ recurse down
    * ❌ recurse down relations
    * ❌ is_in
    * ❌ timeline
    * ❌ local
    * ❌ convert
    * ❌ make
    * Filters
        * ✅ has-kv
        * ✅ bbox
        * ✅ recurse refs
        * ❌ recurse way cnt/link
        * ✅ input set
        * ✅ id
        * ❌ around
        * ❌ poly
        * ❌ newer
        * ❌ changed
        * ❌ user
        * ❌ area
        * ❌ pivot
        * ❌ if
    * ❌ evaluators

## Contributing

Issues and pull requests welcome through
[GitHub](https://github.com/stevenvergenz/osm-overpass-rs].


License: MIT