ng-postcode 0.5.0

Parse, validate and format Nigeria's NIPOST digital postcode (NDAPS) offline, plus a client for the postcode.gov.ng API.
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

//! Nigeria's National Digital Alphanumeric Postcode (NDAPS), the
//! building-level postcode issued by NIPOST.
//!
//! The crate has a pure core and an optional shell:
//!
//! - [`Postcode`] parses, validates and formats codes offline.
//! - [`api`] (feature `api`) describes the NIPOST API as plain data: requests
//!   to send and responses to decode, with no I/O.
//! - [`client`] (feature `client`) is a small blocking HTTP client over `api`.
//!
//! ```
//! use ng_postcode::{Postcode, Segment};
//!
//! let code: Postcode = "ek 01 a03 fk 01".parse()?;
//! assert_eq!(code.to_string(), "EK-01-A03-FK-01");
//! assert_eq!(code.as_str(), "EK01A03FK01");
//! assert_eq!(code.state(), "EK");
//! assert_eq!(code.prefix(Segment::Area), "EK-01-A03-FK");
//! # Ok::<(), ng_postcode::ParseError>(())
//! ```

mod postcode;

#[cfg(feature = "api")]
pub mod api;
#[cfg(feature = "client")]
pub mod client;

pub use postcode::{is_valid, Corrected, ParseError, Postcode, Segment};

// Compiles and runs the examples in the crate README.
#[cfg(all(doctest, feature = "client"))]
#[doc = include_str!("../CRATE.md")]
struct Readme;