ascii_domain

ascii_domain is a library for efficiently parsing domains based on a supplied ASCII character set one wants to enforce each Label to conform to. The primary type in the library is Domain which can be thought of as a domain in representation format. Technically since any ASCII u8 except b'.' is allowed in a Label, it is more general than an actual representation format that doesn't include some form of escape characters. For a full-fledged DNS library look elsewhere (e.g., domain).

The purpose of this library is to allow efficient customization of domain name parsing while still retaining the hierarchical structure of a domain. Depending on one’s use case, allowed formats and characters can differ. If one wants to conform to the Domain Name System (DNS), all octets are allowed; but conforming to RFC 1123 or RFC 5891 requires stricter formats and a reduced character set.

Minimum Supported Rust Version (MSRV)

This will frequently be updated to be the same as stable. Specifically, any time stable is updated and that update has "useful" features or compilation no longer succeeds (e.g., due to new compiler lints), then MSRV will be updated.

MSRV changes will correspond to a SemVer patch version bump pre-1.0.0; otherwise a minor version bump.

SemVer Policy

• All on-by-default features of this library are covered by SemVer
• MSRV is considered exempt from SemVer as noted above

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE)
• MIT license (LICENSE-MIT)

at your option.

Contribution

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

Before any PR is sent, cargo clippy --all-targets, cargo test --all-targets, and cargo test --doc should be run for each possible combination of "features" using the stable and MSRV toolchains. One easy way to achieve this is by invoking ci-cargo as ci-cargo clippy --all-targets test --all-targets in the ascii_domain directory.

Last, RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features should be run to ensure documentation can be built.

Status

The crate is only tested on the x86_64-unknown-linux-gnu, x86_64-unknown-openbsd, and aarch64-apple-darwin targets; but it should work on most platforms.