2024-07-26 09:42:18 +00:00
<!DOCTYPE html> < html lang = "en" > < head > < meta charset = "utf-8" > < meta name = "viewport" content = "width=device-width, initial-scale=1.0" > < meta name = "generator" content = "rustdoc" > < meta name = "description" content = "This Rust crate implements IDNA per the WHATWG URL Standard." > < title > idna - Rust< / title > < script > if ( window . location . protocol !== "file:" ) document . head . insertAdjacentHTML ( "beforeend" , "SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2" . split ( "," ) . map ( f => ` <link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/ ${ f } "> ` ) . join ( "" ) ) < / script > < link rel = "stylesheet" href = "../static.files/normalize-76eba96aa4d2e634.css" > < link rel = "stylesheet" href = "../static.files/rustdoc-dd39b87e5fcfba68.css" > < meta name = "rustdoc-vars" data-root-path = "../" data-static-root-path = "../static.files/" data-current-crate = "idna" data-themes = "" data-resource-suffix = "" data-rustdoc-version = "1.80.0 (051478957 2024-07-21)" data-channel = "1.80.0" data-search-js = "search-d52510db62a78183.js" data-settings-js = "settings-4313503d2e1961c2.js" > < script src = "../static.files/storage-118b08c4c78b968e.js" > < / script > < script defer src = "../crates.js" > < / script > < script defer src = "../static.files/main-20a3ad099b048cf2.js" > < / script > < noscript > < link rel = "stylesheet" href = "../static.files/noscript-df360f571f6edeae.css" > < / noscript > < link rel = "alternate icon" type = "image/png" href = "../static.files/favicon-32x32-422f7d1d52889060.png" > < link rel = "icon" type = "image/svg+xml" href = "../static.files/favicon-2c020d218678b618.svg" > < / head > < body class = "rustdoc mod crate" > <!-- [if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif] --> < nav class = "mobile-topbar" > < button class = "sidebar-menu-toggle" title = "show sidebar" > < / button > < / nav > < nav class = "sidebar" > < div class = "sidebar-crate" > < h2 > < a href = "../idna/index.html" > idna< / a > < span class = "version" > 0.5.0< / span > < / h2 > < / div > < div class = "sidebar-elems" > < ul class = "block" > < li > < a id = "all-types" href = "all.html" > All Items< / a > < / li > < / ul > < section > < ul class = "block" > < li > < a href = "#modules" > Modules< / a > < / li > < li > < a href = "#structs" > Structs< / a > < / li > < li > < a href = "#functions" > Functions< / a > < / li > < / ul > < / section > < / div > < / nav > < div class = "sidebar-resizer" > < / div > < main > < div class = "width-limiter" > < rustdoc-search > < / rustdoc-search > < section id = "main-content" class = "content" > < div class = "main-heading" > < h1 > Crate < a class = "mod" href = "#" > idna< / a > < button id = "copy-path" title = "Copy item path to clipboard" > Copy item path< / button > < / h1 > < span class = "out-of-band" > < a class = "src" href = "../src/idna/lib.rs.html#9-86" > source< / a > · < button id = "toggle-all-docs" title = "collapse all docs" > [< span > − < / span > ]< / button > < / span > < / div > < details class = "toggle top-doc" open > < summary class = "hideme" > < span > Expand description< / span > < / summary > < div class = "docblock" > < p > This Rust crate implements IDNA
2024-03-11 08:39:13 +00:00
< a href = "https://url.spec.whatwg.org/#idna" > per the WHATWG URL Standard< / a > .< / p >
< p > It also exposes the underlying algorithms from < a href = "http://www.unicode.org/reports/tr46/" > < em > Unicode IDNA Compatibility Processing< / em >
(Unicode Technical Standard #46)< / a >
and < a href = "https://tools.ietf.org/html/rfc3492" > Punycode (RFC 3492)< / a > .< / p >
< p > Quoting from < a href = "http://www.unicode.org/reports/tr46/#Introduction" > UTS #46’ s introduction< / a > :< / p >
< blockquote >
< p > Initially, domain names were restricted to ASCII characters.
A system was introduced in 2003 for internationalized domain names (IDN).
This system is called Internationalizing Domain Names for Applications,
or IDNA2003 for short.
This mechanism supports IDNs by means of a client software transformation
into a format known as Punycode.
A revision of IDNA was approved in 2010 (IDNA2008).
This revision has a number of incompatibilities with IDNA2003.< / p >
< p > The incompatibilities force implementers of client software,
such as browsers and emailers,
to face difficult choices during the transition period
as registries shift from IDNA2003 to IDNA2008.
This document specifies a mechanism
that minimizes the impact of this transition for client software,
allowing client software to access domains that are valid under either system.< / p >
< / blockquote >
2024-03-27 11:12:16 +00:00
< / div > < / details > < h2 id = "modules" class = "section-header" > Modules< a href = "#modules" class = "anchor" > §< / a > < / h2 > < ul class = "item-table" > < li > < div class = "item-name" > < a class = "mod" href = "punycode/index.html" title = "mod idna::punycode" > punycode< / a > < / div > < div class = "desc docblock-short" > Punycode (< a href = "http://tools.ietf.org/html/rfc3492" > RFC 3492< / a > ) implementation.< / div > < / li > < / ul > < h2 id = "structs" class = "section-header" > Structs< a href = "#structs" class = "anchor" > §< / a > < / h2 > < ul class = "item-table" > < li > < div class = "item-name" > < a class = "struct" href = "struct.Config.html" title = "struct idna::Config" > Config< / a > < / div > < / li > < li > < div class = "item-name" > < a class = "struct" href = "struct.Errors.html" title = "struct idna::Errors" > Errors< / a > < / div > < div class = "desc docblock-short" > Errors recorded during UTS #46 processing.< / div > < / li > < li > < div class = "item-name" > < a class = "struct" href = "struct.Idna.html" title = "struct idna::Idna" > Idna< / a > < / div > < / li > < / ul > < h2 id = "functions" class = "section-header" > Functions< a href = "#functions" class = "anchor" > §< / a > < / h2 > < ul class = "item-table" > < li > < div class = "item-name" > < a class = "fn" href = "fn.domain_to_ascii.html" title = "fn idna::domain_to_ascii" > domain_to_ascii< / a > < / div > < div class = "desc docblock-short" > The < a href = "https://url.spec.whatwg.org/#concept-domain-to-ascii" > domain to ASCII< / a > algorithm.< / div > < / li > < li > < div class = "item-name" > < a class = "fn" href = "fn.domain_to_ascii_strict.html" title = "fn idna::domain_to_ascii_strict" > domain_to_ascii_strict< / a > < / div > < div class = "desc docblock-short" > The < a href = "https://url.spec.whatwg.org/#concept-domain-to-ascii" > domain to ASCII< / a > algorithm,
2024-03-11 08:39:13 +00:00
with the < code > beStrict< / code > flag set.< / div > < / li > < li > < div class = "item-name" > < a class = "fn" href = "fn.domain_to_unicode.html" title = "fn idna::domain_to_unicode" > domain_to_unicode< / a > < / div > < div class = "desc docblock-short" > The < a href = "https://url.spec.whatwg.org/#concept-domain-to-unicode" > domain to Unicode< / a > algorithm.< / div > < / li > < / ul > < / section > < / div > < / main > < / body > < / html >