Lib.rs

A NationStates API in Rust.

Proud to be 100% safe. Takes full advantage of Rust's type system.

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this work by you, as defined in the Apache-2.0 license, shall be dual-licensed as above, without any additional terms or conditions.

lib.rs:

A NationStates API wrapper that takes full advantage of Rust's type system.

Works with the current API (v12) as of 4 October 2023.

Using the library usually takes three steps:

1. Creating a request (e.g. PublicNationRequest) with the relevant shards.
2. Sending the request as a URL through a Client.
3. Parsing the response using a parser in parsers.

Currently, the following requests can be formed and sent:

• Nation (public shards only): PublicNationRequest::new, from PublicNationShards; also, StandardPublicNationRequest
• Region: RegionRequest::new, from RegionShards; also, StandardRegionRequest
• World (except for regionsfromtag): WorldRequest::new, from WorldShards
• WA (World Assembly): WAShard, from WAShards

The following requests can be parsed:

• Nation (some fields still being finalized)

The following functionality is planned, but is not implemented:

• parsers for Region, World, and WA request responses
• private shards
• lighter-weight client using hyper
• breaking crate into features

Examples

For a list of examples, see the examples folder on GitHub.