14 lines
4.0 KiB
HTML
14 lines
4.0 KiB
HTML
<!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 `is_word_character` fn in crate `regex_syntax`."><meta name="keywords" content="rust, rustlang, rust-lang, is_word_character"><title>regex_syntax::is_word_character - 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="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc fn"><!--[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">☰</div><a href='../regex_syntax/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='index.html'>regex_syntax</a></p><script>window.sidebarCurrent = {name: 'is_word_character', ty: 'fn', 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"><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><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'>−</span>]</a></span><a class='srclink' href='../src/regex_syntax/lib.rs.html#229-231' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='index.html'>regex_syntax</a>::<wbr><a class="fn" href=''>is_word_character</a></span></h1><pre class='rust fn'>pub fn is_word_character(c: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></pre><div class='docblock'><p>Returns true if and only if the given character is a Unicode word
|
||
character.</p>
|
||
<p>A Unicode word character is defined by
|
||
<a href="http://unicode.org/reports/tr18/#Compatibility_Properties">UTS#18 Annex C</a>.
|
||
In particular, a character
|
||
is considered a word character if it is in either of the <code>Alphabetic</code> or
|
||
<code>Join_Control</code> properties, or is in one of the <code>Decimal_Number</code>, <code>Mark</code>
|
||
or <code>Connector_Punctuation</code> general categories.</p>
|
||
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
||
<p>If the <code>unicode-perl</code> feature is not enabled, then this function panics.
|
||
For this reason, it is recommended that callers use
|
||
<a href="fn.try_is_word_character.html"><code>try_is_word_character</code></a>
|
||
instead.</p>
|
||
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "regex_syntax";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |