Files
phy/unicode_properties/trait.UnicodeGeneralCategory.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

15 lines
8.9 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="Query the general category property of a character."><title>UnicodeGeneralCategory in unicode_properties - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="unicode_properties" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../unicode_properties/index.html">unicode_<wbr>properties</a><span class="version">0.1.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Unicode<wbr>General<wbr>Category</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.general_category" title="general_category">general_category</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.general_category_group" title="general_category_group">general_category_group</a></li><li><a href="#method.is_letter_cased" title="is_letter_cased">is_letter_cased</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-UnicodeGeneralCategory-for-char" title="char">char</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate unicode_<wbr>properties</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">unicode_properties</a></span><h1>Trait <span class="trait">UnicodeGeneralCategory</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/unicode_properties/lib.rs.html#135-154">Source</a> </span></div><pre class="rust item-decl"><code>pub trait UnicodeGeneralCategory: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
// Required method
fn <a href="#tymethod.general_category" class="fn">general_category</a>(self) -&gt; <a class="enum" href="general_category/enum.GeneralCategory.html" title="enum unicode_properties::general_category::GeneralCategory">GeneralCategory</a>;
// Provided methods
fn <a href="#method.general_category_group" class="fn">general_category_group</a>(self) -&gt; <a class="enum" href="general_category/enum.GeneralCategoryGroup.html" title="enum unicode_properties::general_category::GeneralCategoryGroup">GeneralCategoryGroup</a> { ... }
<span class="item-spacer"></span> fn <a href="#method.is_letter_cased" class="fn">is_letter_cased</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.bool.html">bool</a> { ... }
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Query the general category property of a character.</p>
<p>See <a href="https://www.unicode.org/reports/tr44/#General_Category_Values">General Category Values</a> for more info.</p>
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.general_category" class="method"><a class="src rightside" href="../src/unicode_properties/lib.rs.html#137">Source</a><h4 class="code-header">fn <a href="#tymethod.general_category" class="fn">general_category</a>(self) -&gt; <a class="enum" href="general_category/enum.GeneralCategory.html" title="enum unicode_properties::general_category::GeneralCategory">GeneralCategory</a></h4></section></summary><div class="docblock"><p>Queries the most general classification of a character.</p>
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.general_category_group" class="method"><a class="src rightside" href="../src/unicode_properties/lib.rs.html#140-142">Source</a><h4 class="code-header">fn <a href="#method.general_category_group" class="fn">general_category_group</a>(self) -&gt; <a class="enum" href="general_category/enum.GeneralCategoryGroup.html" title="enum unicode_properties::general_category::GeneralCategoryGroup">GeneralCategoryGroup</a></h4></section></summary><div class="docblock"><p>Queries the grouping of the most general classification of a character.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_letter_cased" class="method"><a class="src rightside" href="../src/unicode_properties/lib.rs.html#149-153">Source</a><h4 class="code-header">fn <a href="#method.is_letter_cased" class="fn">is_letter_cased</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Queries whether the most general classification of a character belongs to the <code>LetterCased</code> group</p>
<p>The <code>LetterCased</code> group includes <code>LetterUppercase</code>, <code>LetterLowercase</code>, and <code>LetterTitlecase</code>
categories, and is a subset of the <code>Letter</code> group.</p>
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.84.0/reference/items/traits.html#object-safety">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-UnicodeGeneralCategory-for-char" class="impl"><a class="src rightside" href="../src/unicode_properties/lib.rs.html#156-160">Source</a><a href="#impl-UnicodeGeneralCategory-for-char" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.UnicodeGeneralCategory.html" title="trait unicode_properties::UnicodeGeneralCategory">UnicodeGeneralCategory</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.char.html">char</a></h3></section></summary><div class="impl-items"><section id="method.general_category" class="method trait-impl"><a class="src rightside" href="../src/unicode_properties/lib.rs.html#157-159">Source</a><a href="#method.general_category" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.general_category" class="fn">general_category</a>(self) -&gt; <a class="enum" href="general_category/enum.GeneralCategory.html" title="enum unicode_properties::general_category::GeneralCategory">GeneralCategory</a></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/unicode_properties/general_category/trait.UnicodeGeneralCategory.js" data-ignore-extern-crates="core" async></script></section></div></main></body></html>