KA-DEVS/mcquery-rs
5
0
Fork 0
Code Issues Pull Requests Releases Activity

Add generated documentation

Browse Source
This commit is contained in:
Elias Schriefer
2021-01-08 20:01:01 +01:00
parent a379a140d8
commit b89c52748d
10531 changed files with 270352 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/unicode_xid/all.html Normal file
View File

@@ -0,0 +1,4 @@
<!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="List of all items in this crate"><meta name="keywords" content="rust, rustlang, rust-lang"><title>List of all items in this crate</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="https://unicode-rs.github.io/unicode-rs_sm.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../unicode_xid/index.html'><div class='logo-container'><img src='https://unicode-rs.github.io/unicode-rs_sm.png' alt='logo'></div></a><p class="location">Crate unicode_xid</p><div class="block version"><p>Version 0.2.1</p></div><a id="all-types" href="index.html"><p>Back to index</p></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><span class="help-button">?</span>
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span>
</span>
<span class="in-band">List of all items</span></h1><h3 id="Traits">Traits</h3><ul class="traits docblock"><li><a href="trait.UnicodeXID.html">UnicodeXID</a></li></ul><h3 id="Constants">Constants</h3><ul class="constants docblock"><li><a href="constant.UNICODE_VERSION.html">UNICODE_VERSION</a></li></ul></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "unicode_xid";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>

4
doc/unicode_xid/constant.UNICODE_VERSION.html Normal file
View File

@@ -0,0 +1,4 @@
<!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="API documentation for the Rust `UNICODE_VERSION` constant in crate `unicode_xid`."><meta name="keywords" content="rust, rustlang, rust-lang, UNICODE_VERSION"><title>unicode_xid::UNICODE_VERSION - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="https://unicode-rs.github.io/unicode-rs_sm.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc constant"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../unicode_xid/index.html'><div class='logo-container'><img src='https://unicode-rs.github.io/unicode-rs_sm.png' alt='logo'></div></a><div class="sidebar-elems"><p class="location"><a href="index.html">unicode_xid</a></p><script>window.sidebarCurrent = {name: "UNICODE_VERSION", ty: "constant", relpath: ""};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><span class="help-button">?</span>
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../src/unicode_xid/tables.rs.html#17" title="goto source code">[src]</a></span><span class="in-band">Constant <a href="index.html">unicode_xid</a>::<wbr><a class="constant" href="">UNICODE_VERSION</a></span></h1><pre class="rust const">pub const UNICODE_VERSION: (u64, u64, u64);</pre><div class="docblock"><p>The version of <a href="http://www.unicode.org/">Unicode</a>
that this version of unicode-xid is based on.</p>
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "unicode_xid";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>

22
doc/unicode_xid/index.html Normal file
View File

@@ -0,0 +1,22 @@
<!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="API documentation for the Rust `unicode_xid` crate."><meta name="keywords" content="rust, rustlang, rust-lang, unicode_xid"><title>unicode_xid - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="https://unicode-rs.github.io/unicode-rs_sm.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../unicode_xid/index.html'><div class='logo-container'><img src='https://unicode-rs.github.io/unicode-rs_sm.png' alt='logo'></div></a><p class="location">Crate unicode_xid</p><div class="block version"><p>Version 0.2.1</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all unicode_xid's items</p></a><div class="block items"><ul><li><a href="#constants">Constants</a></li><li><a href="#traits">Traits</a></li></ul></div><p class="location"></p><script>window.sidebarCurrent = {name: "unicode_xid", ty: "mod", relpath: "../"};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><span class="help-button">?</span>
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../src/unicode_xid/lib.rs.html#11-84" title="goto source code">[src]</a></span><span class="in-band">Crate <a class="mod" href="">unicode_xid</a></span></h1><div class="docblock"><p>Determine if a <code>char</code> is a valid identifier for a parser and/or lexer according to
<a href="http://www.unicode.org/reports/tr31/">Unicode Standard Annex #31</a> rules.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">unicode_xid</span>;
<span class="kw">use</span> <span class="ident">unicode_xid</span>::<span class="ident">UnicodeXID</span>;
<span class="kw">fn</span> <span class="ident">main</span>() {
<span class="kw">let</span> <span class="ident">ch</span> <span class="op">=</span> <span class="string">&#39;a&#39;</span>;
<span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;Is {} a valid start of an identifier? {}&quot;</span>, <span class="ident">ch</span>, <span class="ident">UnicodeXID</span>::<span class="ident">is_xid_start</span>(<span class="ident">ch</span>));
}</pre></div>
<h1 id="features" class="section-header"><a href="#features">features</a></h1>
<p>unicode-xid supports a <code>no_std</code> feature. This eliminates dependence
on std, and instead uses equivalent functions from core.</p>
</div><h2 id="constants" class="section-header"><a href="#constants">Constants</a></h2>
<table><tr class="module-item"><td><a class="constant" href="constant.UNICODE_VERSION.html" title="unicode_xid::UNICODE_VERSION constant">UNICODE_VERSION</a></td><td class="docblock-short"><p>The version of <a href="http://www.unicode.org/">Unicode</a>
that this version of unicode-xid is based on.</p>
</td></tr></table><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2>
<table><tr class="module-item"><td><a class="trait" href="trait.UnicodeXID.html" title="unicode_xid::UnicodeXID trait">UnicodeXID</a></td><td class="docblock-short"><p>Methods for determining if a character is a valid identifier character.</p>
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "unicode_xid";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>

1
doc/unicode_xid/sidebar-items.js Normal file
View File

@@ -0,0 +1 @@
initSidebarItems({"constant":[["UNICODE_VERSION","The version of Unicode that this version of unicode-xid is based on."]],"trait":[["UnicodeXID","Methods for determining if a character is a valid identifier character."]]});

10
doc/unicode_xid/tables/constant.UNICODE_VERSION.html Normal file
View File

@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../unicode_xid/constant.UNICODE_VERSION.html">
</head>
<body>
<p>Redirecting to <a href="../../unicode_xid/constant.UNICODE_VERSION.html">../../unicode_xid/constant.UNICODE_VERSION.html</a>...</p>
<script>location.replace("../../unicode_xid/constant.UNICODE_VERSION.html" + location.search + location.hash);</script>
</body>
</html>

16
doc/unicode_xid/trait.UnicodeXID.html Normal file
View File

@@ -0,0 +1,16 @@
<!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="API documentation for the Rust `UnicodeXID` trait in crate `unicode_xid`."><meta name="keywords" content="rust, rustlang, rust-lang, UnicodeXID"><title>unicode_xid::UnicodeXID - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="https://unicode-rs.github.io/unicode-rs_sm.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../unicode_xid/index.html'><div class='logo-container'><img src='https://unicode-rs.github.io/unicode-rs_sm.png' alt='logo'></div></a><p class="location">Trait UnicodeXID</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.is_xid_continue">is_xid_continue</a><a href="#tymethod.is_xid_start">is_xid_start</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="index.html">unicode_xid</a></p><script>window.sidebarCurrent = {name: "UnicodeXID", ty: "trait", relpath: ""};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><span class="help-button">?</span>
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../src/unicode_xid/lib.rs.html#56-72" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="index.html">unicode_xid</a>::<wbr><a class="trait" href="">UnicodeXID</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait UnicodeXID {
fn <a href="#tymethod.is_xid_start" class="fnname">is_xid_start</a>(self) -&gt; bool;
<div class="item-spacer"></div> fn <a href="#tymethod.is_xid_continue" class="fnname">is_xid_continue</a>(self) -&gt; bool;
}</pre></div><div class="docblock"><p>Methods for determining if a character is a valid identifier character.</p>
</div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.is_xid_start" class="method"><code>fn <a href="#tymethod.is_xid_start" class="fnname">is_xid_start</a>(self) -&gt; bool</code></h3><div class="docblock"><p>Returns whether the specified character satisfies the 'XID_Start'
Unicode property.</p>
<p>'XID_Start' is a Unicode Derived Property specified in
<a href="http://unicode.org/reports/tr31/#NFKC_Modifications">UAX #31</a>,
mostly similar to ID_Start but modified for closure under NFKx.</p>
</div><h3 id="tymethod.is_xid_continue" class="method"><code>fn <a href="#tymethod.is_xid_continue" class="fnname">is_xid_continue</a>(self) -&gt; bool</code></h3><div class="docblock"><p>Returns whether the specified <code>char</code> satisfies the 'XID_Continue'
Unicode property.</p>
<p>'XID_Continue' is a Unicode Derived Property specified in
<a href="http://unicode.org/reports/tr31/#NFKC_Modifications">UAX #31</a>,
mostly similar to 'ID_Continue' but modified for closure under NFKx.</p>
</div></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><h3 id="impl-UnicodeXID" class="impl"><code class="in-band">impl UnicodeXID for char</code><a href="#impl-UnicodeXID" class="anchor"></a><a class="srclink" href="../src/unicode_xid/lib.rs.html#74-84" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.is_xid_start" class="method hidden"><code>fn <a href="#method.is_xid_start" class="fnname">is_xid_start</a>(self) -&gt; bool</code><a class="srclink" href="../src/unicode_xid/lib.rs.html#76-78" title="goto source code">[src]</a></h4><h4 id="method.is_xid_continue" class="method hidden"><code>fn <a href="#method.is_xid_continue" class="fnname">is_xid_continue</a>(self) -&gt; bool</code><a class="srclink" href="../src/unicode_xid/lib.rs.html#81-83" title="goto source code">[src]</a></h4></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../implementors/unicode_xid/trait.UnicodeXID.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "unicode_xid";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>