blob: 6527e93be161dca06120ab95023abcd4c91059ad [file] [log] [blame]
<!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="This trait abstracts over a data source that is able to produce the Unicode Bidi class for a given character"><meta name="keywords" content="rust, rustlang, rust-lang, BidiDataSource"><title>BidiDataSource in unicode_bidi::data_source - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.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">&#9776;</button><a class="sidebar-logo" href="../../unicode_bidi/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../unicode_bidi/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">BidiDataSource</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.bidi_class">bidi_class</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.bidi_matched_opening_bracket">bidi_matched_opening_bracket</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In unicode_bidi::data_source</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Trait <a href="../index.html">unicode_bidi</a>::<wbr><a href="index.html">data_source</a>::<wbr><a class="trait" href="#">BidiDataSource</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/unicode_bidi/data_source.rs.html#29-46">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait BidiDataSource {
fn <a href="#tymethod.bidi_class" class="fnname">bidi_class</a>(&amp;self, c: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>) -&gt; <a class="enum" href="../enum.BidiClass.html" title="enum unicode_bidi::BidiClass">BidiClass</a>;
fn <a href="#method.bidi_matched_opening_bracket" class="fnname">bidi_matched_opening_bracket</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;self,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;c: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="struct.BidiMatchedOpeningBracket.html" title="struct unicode_bidi::data_source::BidiMatchedOpeningBracket">BidiMatchedOpeningBracket</a>&gt; { ... }
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This trait abstracts over a data source that is able to produce the Unicode Bidi class for a given
character</p>
</div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><section id="tymethod.bidi_class" class="method has-srclink"><a class="srclink rightside" href="../../src/unicode_bidi/data_source.rs.html#30">source</a><h4 class="code-header">fn <a href="#tymethod.bidi_class" class="fnname">bidi_class</a>(&amp;self, c: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>) -&gt; <a class="enum" href="../enum.BidiClass.html" title="enum unicode_bidi::BidiClass">BidiClass</a></h4></section></div><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.bidi_matched_opening_bracket" class="method has-srclink"><a class="srclink rightside" href="../../src/unicode_bidi/data_source.rs.html#43-45">source</a><h4 class="code-header">fn <a href="#method.bidi_matched_opening_bracket" class="fnname">bidi_matched_opening_bracket</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self,<br>&nbsp;&nbsp;&nbsp;&nbsp;c: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="struct.BidiMatchedOpeningBracket.html" title="struct unicode_bidi::data_source::BidiMatchedOpeningBracket">BidiMatchedOpeningBracket</a>&gt;</h4></section></summary><div class="docblock"><p>If this character is a bracket according to BidiBrackets.txt,
return the corresponding <em>normalized</em> <em>opening bracket</em> of the pair,
and whether or not it itself is an opening bracket.</p>
<p>This effectively buckets brackets into equivalence classes keyed on the
normalized opening bracket.</p>
<p>The default implementation will pull in a small amount of hardcoded data,
regardless of the <code>hardcoded-data</code> feature. This is in part for convenience
(since this data is small and changes less often), and in part so that this method can be
added without needing a breaking version bump.
Override this method in your custom data source to prevent the use of hardcoded data.</p>
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><section id="impl-BidiDataSource-for-HardcodedBidiData" class="impl has-srclink"><a class="srclink rightside" href="../../src/unicode_bidi/char_data/mod.rs.html#33-37">source</a><a href="#impl-BidiDataSource-for-HardcodedBidiData" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.BidiDataSource.html" title="trait unicode_bidi::data_source::BidiDataSource">BidiDataSource</a> for <a class="struct" href="../struct.HardcodedBidiData.html" title="struct unicode_bidi::HardcodedBidiData">HardcodedBidiData</a></h3></section></div><script src="../../implementors/unicode_bidi/data_source/trait.BidiDataSource.js" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="unicode_bidi" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>