<!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="Source to the Rust file `/home/travis/.cargo/registry/src/github.com-1ecc6299db9ec823/idna-0.1.0/src/lib.rs`."> <meta name="keywords" content="rust, rustlang, rust-lang"> <title>lib.rs.html -- source</title> <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> <link rel="stylesheet" type="text/css" href="../../main.css"> </head> <body class="rustdoc"> <!--[if lte IE 8]> <div class="warning"> This old browser is unsupported and will most likely display funky things. </div> <![endif]--> <nav class="sidebar"> </nav> <nav class="sub"> <form class="search-form js-only"> <div class="search-container"> <input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"> </div> </form> </nav> <section id='main' class="content source"><pre class="line-numbers"><span id="1"> 1</span> <span id="2"> 2</span> <span id="3"> 3</span> <span id="4"> 4</span> <span id="5"> 5</span> <span id="6"> 6</span> <span id="7"> 7</span> <span id="8"> 8</span> <span id="9"> 9</span> <span id="10">10</span> <span id="11">11</span> <span id="12">12</span> <span id="13">13</span> <span id="14">14</span> <span id="15">15</span> <span id="16">16</span> <span id="17">17</span> <span id="18">18</span> <span id="19">19</span> <span id="20">20</span> <span id="21">21</span> <span id="22">22</span> <span id="23">23</span> <span id="24">24</span> <span id="25">25</span> <span id="26">26</span> <span id="27">27</span> <span id="28">28</span> <span id="29">29</span> <span id="30">30</span> <span id="31">31</span> <span id="32">32</span> <span id="33">33</span> <span id="34">34</span> <span id="35">35</span> <span id="36">36</span> <span id="37">37</span> <span id="38">38</span> <span id="39">39</span> <span id="40">40</span> <span id="41">41</span> <span id="42">42</span> <span id="43">43</span> <span id="44">44</span> <span id="45">45</span> <span id="46">46</span> <span id="47">47</span> <span id="48">48</span> <span id="49">49</span> <span id="50">50</span> <span id="51">51</span> <span id="52">52</span> <span id="53">53</span> <span id="54">54</span> <span id="55">55</span> <span id="56">56</span> <span id="57">57</span> <span id="58">58</span> <span id="59">59</span> <span id="60">60</span> <span id="61">61</span> <span id="62">62</span> <span id="63">63</span> <span id="64">64</span> <span id="65">65</span> <span id="66">66</span> <span id="67">67</span> <span id="68">68</span> <span id="69">69</span> <span id="70">70</span> <span id="71">71</span> <span id="72">72</span> <span id="73">73</span> </pre><pre class='rust '> <span class='comment'>// Copyright 2016 Simon Sapin.</span> <span class='comment'>//</span> <span class='comment'>// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or</span> <span class='comment'>// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license</span> <span class='comment'>// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your</span> <span class='comment'>// option. This file may not be copied, modified, or distributed</span> <span class='comment'>// except according to those terms.</span> <span class='doccomment'>//! This Rust crate implements IDNA</span> <span class='doccomment'>//! [per the WHATWG URL Standard](https://url.spec.whatwg.org/#idna).</span> <span class='doccomment'>//!</span> <span class='doccomment'>//! It also exposes the underlying algorithms from [*Unicode IDNA Compatibility Processing*</span> <span class='doccomment'>//! (Unicode Technical Standard #46)](http://www.unicode.org/reports/tr46/)</span> <span class='doccomment'>//! and [Punycode (RFC 3492)](https://tools.ietf.org/html/rfc3492).</span> <span class='doccomment'>//!</span> <span class='doccomment'>//! Quoting from [UTS #46’s introduction](http://www.unicode.org/reports/tr46/#Introduction):</span> <span class='doccomment'>//!</span> <span class='doccomment'>//! > Initially, domain names were restricted to ASCII characters.</span> <span class='doccomment'>//! > A system was introduced in 2003 for internationalized domain names (IDN).</span> <span class='doccomment'>//! > This system is called Internationalizing Domain Names for Applications,</span> <span class='doccomment'>//! > or IDNA2003 for short.</span> <span class='doccomment'>//! > This mechanism supports IDNs by means of a client software transformation</span> <span class='doccomment'>//! > into a format known as Punycode.</span> <span class='doccomment'>//! > A revision of IDNA was approved in 2010 (IDNA2008).</span> <span class='doccomment'>//! > This revision has a number of incompatibilities with IDNA2003.</span> <span class='doccomment'>//! ></span> <span class='doccomment'>//! > The incompatibilities force implementers of client software,</span> <span class='doccomment'>//! > such as browsers and emailers,</span> <span class='doccomment'>//! > to face difficult choices during the transition period</span> <span class='doccomment'>//! > as registries shift from IDNA2003 to IDNA2008.</span> <span class='doccomment'>//! > This document specifies a mechanism</span> <span class='doccomment'>//! > that minimizes the impact of this transition for client software,</span> <span class='doccomment'>//! > allowing client software to access domains that are valid under either system.</span> <span class='attribute'>#[<span class='ident'>macro_use</span>]</span> <span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>matches</span>; <span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>unicode_bidi</span>; <span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>unicode_normalization</span>; <span class='kw'>pub</span> <span class='kw'>mod</span> <span class='ident'>punycode</span>; <span class='kw'>pub</span> <span class='kw'>mod</span> <span class='ident'>uts46</span>; <span class='doccomment'>/// The [domain to ASCII](https://url.spec.whatwg.org/#concept-domain-to-ascii) algorithm.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// Return the ASCII representation a domain name,</span> <span class='doccomment'>/// normalizing characters (upper-case to lower-case and other kinds of equivalence)</span> <span class='doccomment'>/// and using Punycode as necessary.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// This process may fail.</span> <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>domain_to_ascii</span>(<span class='ident'>domain</span>: <span class='kw-2'>&</span><span class='ident'>str</span>) <span class='op'>-></span> <span class='prelude-ty'>Result</span><span class='op'><</span><span class='ident'>String</span>, <span class='ident'>uts46</span>::<span class='ident'>Errors</span><span class='op'>></span> { <span class='ident'>uts46</span>::<span class='ident'>to_ascii</span>(<span class='ident'>domain</span>, <span class='ident'>uts46</span>::<span class='ident'>Flags</span> { <span class='ident'>use_std3_ascii_rules</span>: <span class='bool-val'>false</span>, <span class='ident'>transitional_processing</span>: <span class='bool-val'>true</span>, <span class='comment'>// XXX: switch when Firefox does</span> <span class='ident'>verify_dns_length</span>: <span class='bool-val'>false</span>, }) } <span class='doccomment'>/// The [domain to Unicode](https://url.spec.whatwg.org/#concept-domain-to-unicode) algorithm.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// Return the Unicode representation of a domain name,</span> <span class='doccomment'>/// normalizing characters (upper-case to lower-case and other kinds of equivalence)</span> <span class='doccomment'>/// and decoding Punycode as necessary.</span> <span class='doccomment'>///</span> <span class='doccomment'>/// This may indicate [syntax violations](https://url.spec.whatwg.org/#syntax-violation)</span> <span class='doccomment'>/// but always returns a string for the mapped domain.</span> <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>domain_to_unicode</span>(<span class='ident'>domain</span>: <span class='kw-2'>&</span><span class='ident'>str</span>) <span class='op'>-></span> (<span class='ident'>String</span>, <span class='prelude-ty'>Result</span><span class='op'><</span>(), <span class='ident'>uts46</span>::<span class='ident'>Errors</span><span class='op'>></span>) { <span class='ident'>uts46</span>::<span class='ident'>to_unicode</span>(<span class='ident'>domain</span>, <span class='ident'>uts46</span>::<span class='ident'>Flags</span> { <span class='ident'>use_std3_ascii_rules</span>: <span class='bool-val'>false</span>, <span class='comment'>// Unused:</span> <span class='ident'>transitional_processing</span>: <span class='bool-val'>true</span>, <span class='ident'>verify_dns_length</span>: <span class='bool-val'>false</span>, }) } </pre> </section> <section id='search' class="content hidden"></section> <section class="footer"></section> <aside id="help" class="hidden"> <div> <h1 class="hidden">Help</h1> <div class="shortcuts"> <h2>Keyboard Shortcuts</h2> <dl> <dt>?</dt> <dd>Show this help dialog</dd> <dt>S</dt> <dd>Focus the search field</dd> <dt>⇤</dt> <dd>Move up in search results</dd> <dt>⇥</dt> <dd>Move down in search results</dd> <dt>⏎</dt> <dd>Go to active search result</dd> <dt>+</dt> <dd>Collapse/expand all sections</dd> </dl> </div> <div class="infos"> <h2>Search Tricks</h2> <p> Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type. </p> <p> Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>. </p> <p> Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>) </p> </div> </div> </aside> <script> window.rootPath = "../../"; window.currentCrate = "idna"; window.playgroundUrl = ""; </script> <script src="../../jquery.js"></script> <script src="../../main.js"></script> <script defer src="../../search-index.js"></script> </body> </html>