mentat/unicode_xid/trait.UnicodeXID.html

154 lines
7.2 KiB
HTML
Raw Permalink Normal View History

2018-08-22 17:04:13 +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="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="../dark.css">
<link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
<script src="../storage.js"></script>
<link rel="shortcut icon" href="https://unicode-rs.github.io/unicode-rs_sm.png">
</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'><img src='https://unicode-rs.github.io/unicode-rs_sm.png' alt='logo' width='100'></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_start">is_xid_start</a><a href="#tymethod.is_xid_continue">is_xid_continue</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!">
<img src="../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../theme.js"></script>
<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">
<h1 class='fqn'><span class='in-band'>Trait <a href='index.html'>unicode_xid</a>::<wbr><a class="trait" href=''>UnicodeXID</a></span><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#63-79' title='goto source code'>[src]</a></span></h1>
<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 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'><span id='is_xid_start.v' class='invisible'><code>fn <a href='#tymethod.is_xid_start' class='fnname'>is_xid_start</a>(self) -&gt; bool</code></span></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'><span id='is_xid_continue.v' class='invisible'><code>fn <a href='#tymethod.is_xid_continue' class='fnname'>is_xid_continue</a>(self) -&gt; bool</code></span></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>
<h2 id='implementors' class='small-section-header'>
Implementors<a href='#implementors' class='anchor'></a>
</h2>
<ul class='item-list' id='implementors-list'>
<li><div class='out-of-band'><a class='srclink' href='../src/unicode_xid/lib.rs.html#81-87' title='goto source code'>[src]</a></div><code>impl UnicodeXID for char</code></li>
</ul><script type="text/javascript" async
src="../implementors/unicode_xid/trait.UnicodeXID.js">
</script></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><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd></kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd></kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd></kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>&#9166;</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse 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 = "unicode_xid";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>