# `ascii_domain`
[<img alt="git" src="https://git.philomathiclife.com/badges/ascii_domain.svg" height="20">](https://git.philomathiclife.com/ascii_domain/log.html)
[<img alt="crates.io" src="https://img.shields.io/crates/v/ascii_domain.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/ascii_domain)
[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-ascii_domain-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs" height="20">](https://docs.rs/ascii_domain/latest/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`](https://docs.rs/domain/latest/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)](https://www.rfc-editor.org/rfc/rfc2181),
all octets are allowed; but conforming to [RFC 1123](https://www.rfc-editor.org/rfc/rfc1123) or
[RFC 5891](https://datatracker.ietf.org/doc/html/rfc5891) 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](https://www.apache.org/licenses/LICENSE-2.0))
* MIT license ([LICENSE-MIT](https://opensource.org/licenses/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` and `cargo t` should be run for both `--no-default-features` and
`--all-features`. Additionally `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.