anil.recoil.org
OCaml implementation of the Mozilla Public Suffix service
odoc
+10
-3
+10
-3
lib/publicsuffix.mli
+10
-3
lib/publicsuffix.mli
···
74
74
to Punycode (ASCII-compatible encoding) before lookup, following the IDNA2008
75
75
protocol defined in {{:https://datatracker.ietf.org/doc/html/rfc5890}RFC 5890}
76
76
(IDNA Definitions) and {{:https://datatracker.ietf.org/doc/html/rfc5891}RFC 5891}
77
-
(IDNA Protocol).
77
+
(IDNA Protocol). The conversion is performed using [Punycode_idna.to_ascii].
78
78
79
79
Punycode encoding, specified in {{:https://datatracker.ietf.org/doc/html/rfc3492}RFC 3492},
80
80
uniquely and reversibly transforms Unicode strings into ASCII-compatible
81
-
strings using the "xn--" prefix (ACE prefix). Both Unicode and Punycode
82
-
input are accepted:
81
+
strings using the "xn--" prefix (ACE prefix). See the [Punycode] library for
82
+
the core encoding implementation. Both Unicode and Punycode input are accepted:
83
83
84
84
{[
85
85
Publicsuffix.registrable_domain psl "www.食狮.com.cn"
···
113
113
{- {{:https://datatracker.ietf.org/doc/html/rfc3492}RFC 3492} - Punycode: A Bootstring encoding of Unicode for IDNA}
114
114
{- {{:https://datatracker.ietf.org/doc/html/rfc5890}RFC 5890} - Internationalized Domain Names for Applications (IDNA): Definitions}
115
115
{- {{:https://datatracker.ietf.org/doc/html/rfc5891}RFC 5891} - Internationalized Domain Names in Applications (IDNA): Protocol}}
116
+
117
+
{1 Related Libraries}
118
+
119
+
{ul
120
+
{- [Punycode] - Core Punycode encoding/decoding implementation}
121
+
{- [Punycode_idna] - IDNA ToASCII/ToUnicode operations used for IDN conversion}}
116
122
*)
117
123
118
124
(** {1 Types} *)
···
141
147
domain names should not have leading dots. *)
142
148
| Punycode_error of string
143
149
(** Failed to convert internationalized domain to Punycode encoding.
150
+
The string contains the error message from [Punycode_idna].
144
151
See {{:https://datatracker.ietf.org/doc/html/rfc3492}RFC 3492}
145
152
for Punycode encoding requirements and
146
153
{{:https://datatracker.ietf.org/doc/html/rfc5891}RFC 5891}