trait.UnicodeXID.html 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  6. <meta name="generator" content="rustdoc">
  7. <meta name="description" content="API documentation for the Rust `UnicodeXID` trait in crate `unicode_xid`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, UnicodeXID">
  9. <title>unicode_xid::UnicodeXID - Rust</title>
  10. <link rel="stylesheet" type="text/css" href="../normalize.css">
  11. <link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle">
  12. <link rel="stylesheet" type="text/css" href="../dark.css">
  13. <link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
  14. <script src="../storage.js"></script>
  15. <link rel="shortcut icon" href="https://unicode-rs.github.io/unicode-rs_sm.png">
  16. </head>
  17. <body class="rustdoc trait">
  18. <!--[if lte IE 8]>
  19. <div class="warning">
  20. This old browser is unsupported and will most likely display funky
  21. things.
  22. </div>
  23. <![endif]-->
  24. <nav class="sidebar">
  25. <div class="sidebar-menu">&#9776;</div>
  26. <a href='../unicode_xid/index.html'><img src='https://unicode-rs.github.io/unicode-rs_sm.png' alt='logo' width='100'></a>
  27. <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>
  28. </nav>
  29. <div class="theme-picker">
  30. <button id="theme-picker" aria-label="Pick another theme!">
  31. <img src="../brush.svg" width="18" alt="Pick another theme!">
  32. </button>
  33. <div id="theme-choices"></div>
  34. </div>
  35. <script src="../theme.js"></script>
  36. <nav class="sub">
  37. <form class="search-form js-only">
  38. <div class="search-container">
  39. <input class="search-input" name="search"
  40. autocomplete="off"
  41. placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
  42. type="search">
  43. </div>
  44. </form>
  45. </nav>
  46. <section id='main' class="content">
  47. <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'>
  48. <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
  49. [<span class='inner'>&#x2212;</span>]
  50. </a>
  51. </span><a class='srclink' href='../src/unicode_xid/lib.rs.html#63-79' title='goto source code'>[src]</a></span></h1>
  52. <pre class='rust trait'>pub trait UnicodeXID {
  53. fn <a href='#tymethod.is_xid_start' class='fnname'>is_xid_start</a>(self) -&gt; bool;
  54. <div class='item-spacer'></div> fn <a href='#tymethod.is_xid_continue' class='fnname'>is_xid_continue</a>(self) -&gt; bool;
  55. }</pre><div class='docblock'><p>Methods for determining if a character is a valid identifier character.</p>
  56. </div>
  57. <h2 id='required-methods' class='small-section-header'>
  58. Required Methods<a href='#required-methods' class='anchor'></a>
  59. </h2>
  60. <div class='methods'>
  61. <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'
  62. Unicode property.</p>
  63. <p>'XID_Start' is a Unicode Derived Property specified in
  64. <a href="http://unicode.org/reports/tr31/#NFKC_Modifications">UAX #31</a>,
  65. mostly similar to ID_Start but modified for closure under NFKx.</p>
  66. </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'
  67. Unicode property.</p>
  68. <p>'XID_Continue' is a Unicode Derived Property specified in
  69. <a href="http://unicode.org/reports/tr31/#NFKC_Modifications">UAX #31</a>,
  70. mostly similar to 'ID_Continue' but modified for closure under NFKx.</p>
  71. </div></div>
  72. <h2 id='implementors' class='small-section-header'>
  73. Implementors<a href='#implementors' class='anchor'></a>
  74. </h2>
  75. <ul class='item-list' id='implementors-list'>
  76. <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>
  77. </ul><script type="text/javascript" async
  78. src="../implementors/unicode_xid/trait.UnicodeXID.js">
  79. </script></section>
  80. <section id='search' class="content hidden"></section>
  81. <section class="footer"></section>
  82. <aside id="help" class="hidden">
  83. <div>
  84. <h1 class="hidden">Help</h1>
  85. <div class="shortcuts">
  86. <h2>Keyboard Shortcuts</h2>
  87. <dl>
  88. <dt><kbd>?</kbd></dt>
  89. <dd>Show this help dialog</dd>
  90. <dt><kbd>S</kbd></dt>
  91. <dd>Focus the search field</dd>
  92. <dt><kbd>↑</kbd></dt>
  93. <dd>Move up in search results</dd>
  94. <dt><kbd>↓</kbd></dt>
  95. <dd>Move down in search results</dd>
  96. <dt><kbd>↹</kbd></dt>
  97. <dd>Switch tab</dd>
  98. <dt><kbd>&#9166;</kbd></dt>
  99. <dd>Go to active search result</dd>
  100. <dt><kbd>+</kbd></dt>
  101. <dd>Expand all sections</dd>
  102. <dt><kbd>-</kbd></dt>
  103. <dd>Collapse all sections</dd>
  104. </dl>
  105. </div>
  106. <div class="infos">
  107. <h2>Search Tricks</h2>
  108. <p>
  109. Prefix searches with a type followed by a colon (e.g.
  110. <code>fn:</code>) to restrict the search to a given type.
  111. </p>
  112. <p>
  113. Accepted types are: <code>fn</code>, <code>mod</code>,
  114. <code>struct</code>, <code>enum</code>,
  115. <code>trait</code>, <code>type</code>, <code>macro</code>,
  116. and <code>const</code>.
  117. </p>
  118. <p>
  119. Search functions by type signature (e.g.
  120. <code>vec -> usize</code> or <code>* -> vec</code>)
  121. </p>
  122. </div>
  123. </div>
  124. </aside>
  125. <script>
  126. window.rootPath = "../";
  127. window.currentCrate = "unicode_xid";
  128. </script>
  129. <script src="../main.js"></script>
  130. <script defer src="../search-index.js"></script>
  131. </body>
  132. </html>