ascii_domain 0.6.6

Parser for DNS names based on a provided ASCII character set.
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
35

//! [![git]](https://git.philomathiclife.com/ascii_domain/log.html) [![crates-io]](https://crates.io/crates/ascii_domain) [![docs-rs]](crate)
//!
//! [git]: https://git.philomathiclife.com/git_badge.svg
//! [crates-io]: https://img.shields.io/badge/crates.io-fc8d62?style=for-the-badge&labelColor=555555&logo=rust
//! [docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs
//!
//! `ascii_domain` is a library for efficiently parsing domains based on a supplied ASCII character set one
//! wants to enforce each [`dom::Label`] to conform to. The primary type in the library is [`dom::Domain`]
//! which can be thought of as domains 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.
#![cfg_attr(docsrs, feature(doc_cfg))]
#![no_std]
/// Contains [`char_set::AllowedAscii`] which is how one dictates the character set [`dom::Domain::try_from_bytes`]
/// uses.
pub mod char_set;
/// Contains [`dom::Domain`] which is a domain whose [`dom::Label`]s consist of a subset of the supplied
/// [`char_set::AllowedAscii`].
///
/// Also contains [`dom::Rfc1123Domain`] which is a `Domain` that conforms to
/// [RFC 1123](https://www.rfc-editor.org/rfc/rfc1123#page-13).
pub mod dom;
/// Contains a Serde [`Visitor`](https://docs.rs/serde/latest/serde/de/trait.Visitor.html) that can be used to help
/// deserialize [`dom::Domain`] wrappers.
#[cfg_attr(docsrs, doc(cfg(feature = "serde")))]
#[cfg(feature = "serde")]
pub mod serde;