edlang/unicode_bidi/struct.BidiInfo.html
2024-07-26 09:42:18 +00:00

120 lines
42 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Bidi information of the text."><title>BidiInfo in unicode_bidi - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.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-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="unicode_bidi" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc struct"><!--[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_bidi/index.html">unicode_bidi</a><span class="version">0.3.15</span></h2></div><h2 class="location"><a href="#">BidiInfo</a></h2><div class="sidebar-elems"><section><h3><a href="#fields">Fields</a></h3><ul class="block structfield"><li><a href="#structfield.levels">levels</a></li><li><a href="#structfield.original_classes">original_classes</a></li><li><a href="#structfield.paragraphs">paragraphs</a></li><li><a href="#structfield.text">text</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.has_rtl">has_rtl</a></li><li><a href="#method.new">new</a></li><li><a href="#method.new_with_data_source">new_with_data_source</a></li><li><a href="#method.reorder_line">reorder_line</a></li><li><a href="#method.reorder_visual">reorder_visual</a></li><li><a href="#method.reordered_levels">reordered_levels</a></li><li><a href="#method.reordered_levels_per_char">reordered_levels_per_char</a></li><li><a href="#method.visual_runs">visual_runs</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-BidiInfo%3C'text%3E">Debug</a></li><li><a href="#impl-PartialEq-for-BidiInfo%3C'text%3E">PartialEq</a></li><li><a href="#impl-StructuralPartialEq-for-BidiInfo%3C'text%3E">StructuralPartialEq</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-BidiInfo%3C'text%3E">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-BidiInfo%3C'text%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-BidiInfo%3C'text%3E">Send</a></li><li><a href="#impl-Sync-for-BidiInfo%3C'text%3E">Sync</a></li><li><a href="#impl-Unpin-for-BidiInfo%3C'text%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-BidiInfo%3C'text%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-From%3CT%3E-for-T">From&lt;T&gt;</a></li><li><a href="#impl-Into%3CU%3E-for-T">Into&lt;U&gt;</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-T">TryInto&lt;U&gt;</a></li></ul></section><h2><a href="index.html">In crate unicode_bidi</a></h2></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"><h1>Struct <a href="index.html">unicode_bidi</a>::<wbr><a class="struct" href="#">BidiInfo</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/unicode_bidi/lib.rs.html#430-445">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub struct BidiInfo&lt;'text&gt; {
pub text: &amp;'text <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>,
pub original_classes: <a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="enum" href="enum.BidiClass.html" title="enum unicode_bidi::BidiClass">BidiClass</a>&gt;,
pub levels: <a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="level/struct.Level.html" title="struct unicode_bidi::level::Level">Level</a>&gt;,
pub paragraphs: <a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="struct.ParagraphInfo.html" title="struct unicode_bidi::ParagraphInfo">ParagraphInfo</a>&gt;,
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Bidi information of the text.</p>
<p>The <code>original_classes</code> and <code>levels</code> vectors are indexed by byte offsets into the text. If a
character is multiple bytes wide, then its class and level will appear multiple times in these
vectors.</p>
</div></details><h2 id="fields" class="fields section-header">Fields<a href="#fields" class="anchor">§</a></h2><span id="structfield.text" class="structfield section-header"><a href="#structfield.text" class="anchor field">§</a><code>text: &amp;'text <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a></code></span><div class="docblock"><p>The text</p>
</div><span id="structfield.original_classes" class="structfield section-header"><a href="#structfield.original_classes" class="anchor field">§</a><code>original_classes: <a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="enum" href="enum.BidiClass.html" title="enum unicode_bidi::BidiClass">BidiClass</a>&gt;</code></span><div class="docblock"><p>The BidiClass of the character at each byte in the text.</p>
</div><span id="structfield.levels" class="structfield section-header"><a href="#structfield.levels" class="anchor field">§</a><code>levels: <a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="level/struct.Level.html" title="struct unicode_bidi::level::Level">Level</a>&gt;</code></span><div class="docblock"><p>The directional embedding level of each byte in the text.</p>
</div><span id="structfield.paragraphs" class="structfield section-header"><a href="#structfield.paragraphs" class="anchor field">§</a><code>paragraphs: <a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="struct.ParagraphInfo.html" title="struct unicode_bidi::ParagraphInfo">ParagraphInfo</a>&gt;</code></span><div class="docblock"><p>The boundaries and paragraph embedding level of each paragraph within the text.</p>
<p>TODO: Use SmallVec or similar to avoid overhead when there are only one or two paragraphs?
Or just dont include the first paragraph, which always starts at 0?</p>
</div><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-BidiInfo%3C'text%3E" class="impl"><a class="src rightside" href="../src/unicode_bidi/lib.rs.html#447-660">source</a><a href="#impl-BidiInfo%3C'text%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'text&gt; <a class="struct" href="struct.BidiInfo.html" title="struct unicode_bidi::BidiInfo">BidiInfo</a>&lt;'text&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../src/unicode_bidi/lib.rs.html#460-462">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>(text: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>, default_para_level: <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="level/struct.Level.html" title="struct unicode_bidi::level::Level">Level</a>&gt;) -&gt; <a class="struct" href="struct.BidiInfo.html" title="struct unicode_bidi::BidiInfo">BidiInfo</a>&lt;'_&gt;</h4></section></summary><div class="docblock"><p>Split the text into paragraphs and determine the bidi embedding levels for each paragraph.</p>
<p>The <code>hardcoded-data</code> Cargo feature (enabled by default) must be enabled to use this.</p>
<p>TODO: In early steps, check for special cases that allow later steps to be skipped. like
text that is entirely LTR. See the <code>nsBidi</code> class from Gecko for comparison.</p>
<p>TODO: Support auto-RTL base direction</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.new_with_data_source" class="method"><a class="src rightside" href="../src/unicode_bidi/lib.rs.html#473-505">source</a><h4 class="code-header">pub fn <a href="#method.new_with_data_source" class="fn">new_with_data_source</a>&lt;'a, D: <a class="trait" href="data_source/trait.BidiDataSource.html" title="trait unicode_bidi::data_source::BidiDataSource">BidiDataSource</a>&gt;(
data_source: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&amp;D</a>,
text: &amp;'a <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>,
default_para_level: <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="level/struct.Level.html" title="struct unicode_bidi::level::Level">Level</a>&gt;,
) -&gt; <a class="struct" href="struct.BidiInfo.html" title="struct unicode_bidi::BidiInfo">BidiInfo</a>&lt;'a&gt;</h4></section></summary><div class="docblock"><p>Split the text into paragraphs and determine the bidi embedding levels for each paragraph, with a custom <a href="data_source/trait.BidiDataSource.html" title="trait unicode_bidi::data_source::BidiDataSource"><code>BidiDataSource</code></a>
for Bidi data. If you just wish to use the hardcoded Bidi data, please use <a href="struct.BidiInfo.html#method.new" title="associated function unicode_bidi::BidiInfo::new"><code>BidiInfo::new()</code></a>
instead (enabled with tbe default <code>hardcoded-data</code> Cargo feature).</p>
<p>TODO: In early steps, check for special cases that allow later steps to be skipped. like
text that is entirely LTR. See the <code>nsBidi</code> class from Gecko for comparison.</p>
<p>TODO: Support auto-RTL base direction</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.reordered_levels" class="method"><a class="src rightside" href="../src/unicode_bidi/lib.rs.html#521-537">source</a><h4 class="code-header">pub fn <a href="#method.reordered_levels" class="fn">reordered_levels</a>(
&amp;self,
para: &amp;<a class="struct" href="struct.ParagraphInfo.html" title="struct unicode_bidi::ParagraphInfo">ParagraphInfo</a>,
line: <a class="struct" href="https://doc.rust-lang.org/1.80.0/core/ops/range/struct.Range.html" title="struct core::ops::range::Range">Range</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</a>&gt;,
) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="level/struct.Level.html" title="struct unicode_bidi::level::Level">Level</a>&gt;</h4></section></summary><div class="docblock"><p>Produce the levels for this paragraph as needed for reordering, one level per <em>byte</em>
in the paragraph. The returned vector includes bytes that are not included
in the <code>line</code>, but will not adjust them.</p>
<p>This runs <a href="https://www.unicode.org/reports/tr9/#L1">Rule L1</a>, you can run
<a href="https://www.unicode.org/reports/tr9/#L2">Rule L2</a> by calling <a href="struct.BidiInfo.html#method.reorder_visual" title="associated function unicode_bidi::BidiInfo::reorder_visual"><code>Self::reorder_visual()</code></a>.
If doing so, you may prefer to use <a href="struct.BidiInfo.html#method.reordered_levels_per_char" title="method unicode_bidi::BidiInfo::reordered_levels_per_char"><code>Self::reordered_levels_per_char()</code></a> instead
to avoid non-byte indices.</p>
<p>For an all-in-one reordering solution, consider using <a href="struct.BidiInfo.html#method.reorder_visual" title="associated function unicode_bidi::BidiInfo::reorder_visual"><code>Self::reorder_visual()</code></a>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.reordered_levels_per_char" class="method"><a class="src rightside" href="../src/unicode_bidi/lib.rs.html#553-560">source</a><h4 class="code-header">pub fn <a href="#method.reordered_levels_per_char" class="fn">reordered_levels_per_char</a>(
&amp;self,
para: &amp;<a class="struct" href="struct.ParagraphInfo.html" title="struct unicode_bidi::ParagraphInfo">ParagraphInfo</a>,
line: <a class="struct" href="https://doc.rust-lang.org/1.80.0/core/ops/range/struct.Range.html" title="struct core::ops::range::Range">Range</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</a>&gt;,
) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="level/struct.Level.html" title="struct unicode_bidi::level::Level">Level</a>&gt;</h4></section></summary><div class="docblock"><p>Produce the levels for this paragraph as needed for reordering, one level per <em>character</em>
in the paragraph. The returned vector includes characters that are not included
in the <code>line</code>, but will not adjust them.</p>
<p>This runs <a href="https://www.unicode.org/reports/tr9/#L1">Rule L1</a>, you can run
<a href="https://www.unicode.org/reports/tr9/#L2">Rule L2</a> by calling <a href="struct.BidiInfo.html#method.reorder_visual" title="associated function unicode_bidi::BidiInfo::reorder_visual"><code>Self::reorder_visual()</code></a>.
If doing so, you may prefer to use <a href="struct.BidiInfo.html#method.reordered_levels_per_char" title="method unicode_bidi::BidiInfo::reordered_levels_per_char"><code>Self::reordered_levels_per_char()</code></a> instead
to avoid non-byte indices.</p>
<p>For an all-in-one reordering solution, consider using <a href="struct.BidiInfo.html#method.reorder_visual" title="associated function unicode_bidi::BidiInfo::reorder_visual"><code>Self::reorder_visual()</code></a>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.reorder_line" class="method"><a class="src rightside" href="../src/unicode_bidi/lib.rs.html#569-575">source</a><h4 class="code-header">pub fn <a href="#method.reorder_line" class="fn">reorder_line</a>(
&amp;self,
para: &amp;<a class="struct" href="struct.ParagraphInfo.html" title="struct unicode_bidi::ParagraphInfo">ParagraphInfo</a>,
line: <a class="struct" href="https://doc.rust-lang.org/1.80.0/core/ops/range/struct.Range.html" title="struct core::ops::range::Range">Range</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</a>&gt;,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a>&lt;'text, <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>&gt;</h4></section></summary><div class="docblock"><p>Re-order a line based on resolved levels and return the line in display order.</p>
<p>This does not apply <a href="https://www.unicode.org/reports/tr9/#L3">Rule L3</a> or <a href="https://www.unicode.org/reports/tr9/#L4">Rule L4</a> around combining characters or mirroring.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.reorder_visual" class="method"><a class="src rightside" href="../src/unicode_bidi/lib.rs.html#614-616">source</a><h4 class="code-header">pub fn <a href="#method.reorder_visual" class="fn">reorder_visual</a>(levels: &amp;[<a class="struct" href="level/struct.Level.html" title="struct unicode_bidi::level::Level">Level</a>]) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</a>&gt;</h4></section></summary><div class="docblock"><p>Reorders pre-calculated levels of a sequence of characters.</p>
<p>NOTE: This is a convenience method that does not use a <code>Paragraph</code> object. It is
intended to be used when an application has determined the levels of the objects (character sequences)
and just needs to have them reordered.</p>
<p>the index map will result in <code>indexMap[visualIndex]==logicalIndex</code>.</p>
<p>This only runs <a href="http://www.unicode.org/reports/tr9/#L2">Rule L2</a> as it does not have
information about the actual text.</p>
<p>Furthermore, if <code>levels</code> is an array that is aligned with code units, bytes within a codepoint may be
reversed. You may need to fix up the map to deal with this. Alternatively, only pass in arrays where each <code>Level</code>
is for a single code point.</p>
<h5 id="-example"><a class="doc-anchor" href="#-example">§</a># Example</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>unicode_bidi::BidiInfo;
<span class="kw">use </span>unicode_bidi::Level;
<span class="kw">let </span>l0 = Level::from(<span class="number">0</span>);
<span class="kw">let </span>l1 = Level::from(<span class="number">1</span>);
<span class="kw">let </span>l2 = Level::from(<span class="number">2</span>);
<span class="kw">let </span>levels = <span class="macro">vec!</span>[l0, l0, l0, l0];
<span class="kw">let </span>index_map = BidiInfo::reorder_visual(<span class="kw-2">&amp;</span>levels);
<span class="macro">assert_eq!</span>(levels.len(), index_map.len());
<span class="macro">assert_eq!</span>(index_map, [<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>]);
<span class="kw">let </span>levels: Vec&lt;Level&gt; = <span class="macro">vec!</span>[l0, l0, l0, l1, l1, l1, l2, l2];
<span class="kw">let </span>index_map = BidiInfo::reorder_visual(<span class="kw-2">&amp;</span>levels);
<span class="macro">assert_eq!</span>(levels.len(), index_map.len());
<span class="macro">assert_eq!</span>(index_map, [<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">5</span>, <span class="number">4</span>, <span class="number">3</span>]);</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.visual_runs" class="method"><a class="src rightside" href="../src/unicode_bidi/lib.rs.html#644-651">source</a><h4 class="code-header">pub fn <a href="#method.visual_runs" class="fn">visual_runs</a>(
&amp;self,
para: &amp;<a class="struct" href="struct.ParagraphInfo.html" title="struct unicode_bidi::ParagraphInfo">ParagraphInfo</a>,
line: <a class="struct" href="https://doc.rust-lang.org/1.80.0/core/ops/range/struct.Range.html" title="struct core::ops::range::Range">Range</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</a>&gt;,
) -&gt; (<a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="level/struct.Level.html" title="struct unicode_bidi::level::Level">Level</a>&gt;, <a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="type" href="type.LevelRun.html" title="type unicode_bidi::LevelRun">LevelRun</a>&gt;)</h4></section></summary><div class="docblock"><p>Find the level runs within a line and return them in visual order.</p>
<p><code>line</code> is a range of bytes indices within <code>levels</code>.</p>
<p>The first return value is a vector of levels used by the reordering algorithm,
i.e. the result of <a href="https://www.unicode.org/reports/tr9/#L1">Rule L1</a>. The second return value is a vector of level runs,
the result of <a href="https://www.unicode.org/reports/tr9/#L2">Rule L2</a>, showing the visual order that each level run (a run of text with the
same level) should be displayed. Within each run, the display order can be checked
against the Level vector.</p>
<p>This does not handle <a href="https://www.unicode.org/reports/tr9/#L3">Rule L3</a> (combining characters) or <a href="https://www.unicode.org/reports/tr9/#L4">Rule L4</a> (mirroring),
as that should be handled by the engine using this API.</p>
<p>Conceptually, this is the same as running <a href="struct.BidiInfo.html#method.reordered_levels" title="method unicode_bidi::BidiInfo::reordered_levels"><code>Self::reordered_levels()</code></a> followed by
<a href="struct.BidiInfo.html#method.reorder_visual" title="associated function unicode_bidi::BidiInfo::reorder_visual"><code>Self::reorder_visual()</code></a>, however it returns the result as a list of level runs instead
of producing a level map, since one may wish to deal with the fact that this is operating on
byte rather than character indices.</p>
<p><a href="http://www.unicode.org/reports/tr9/#Reordering_Resolved_Levels">http://www.unicode.org/reports/tr9/#Reordering_Resolved_Levels</a></p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.has_rtl" class="method"><a class="src rightside" href="../src/unicode_bidi/lib.rs.html#657-659">source</a><h4 class="code-header">pub fn <a href="#method.has_rtl" class="fn">has_rtl</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>If processed text has any computed RTL levels</p>
<p>This information is usually used to skip re-ordering of text when no RTL level is present</p>
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-BidiInfo%3C'text%3E" class="impl"><a class="src rightside" href="../src/unicode_bidi/lib.rs.html#429">source</a><a href="#impl-Debug-for-BidiInfo%3C'text%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'text&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.BidiInfo.html" title="struct unicode_bidi::BidiInfo">BidiInfo</a>&lt;'text&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../src/unicode_bidi/lib.rs.html#429">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/1.80.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/1.80.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-PartialEq-for-BidiInfo%3C'text%3E" class="impl"><a class="src rightside" href="../src/unicode_bidi/lib.rs.html#429">source</a><a href="#impl-PartialEq-for-BidiInfo%3C'text%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'text&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="struct" href="struct.BidiInfo.html" title="struct unicode_bidi::BidiInfo">BidiInfo</a>&lt;'text&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.eq" class="method trait-impl"><a class="src rightside" href="../src/unicode_bidi/lib.rs.html#429">source</a><a href="#method.eq" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/cmp/trait.PartialEq.html#tymethod.eq" class="fn">eq</a>(&amp;self, other: &amp;<a class="struct" href="struct.BidiInfo.html" title="struct unicode_bidi::BidiInfo">BidiInfo</a>&lt;'text&gt;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
by <code>==</code>.</div></details><details class="toggle method-toggle" open><summary><section id="method.ne" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.80.0/src/core/cmp.rs.html#263">source</a></span><a href="#method.ne" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/cmp/trait.PartialEq.html#method.ne" class="fn">ne</a>(&amp;self, other: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&amp;Rhs</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests for <code>!=</code>. The default implementation is almost always
sufficient, and should not be overridden without very good reason.</div></details></div></details><section id="impl-StructuralPartialEq-for-BidiInfo%3C'text%3E" class="impl"><a class="src rightside" href="../src/unicode_bidi/lib.rs.html#429">source</a><a href="#impl-StructuralPartialEq-for-BidiInfo%3C'text%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'text&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.StructuralPartialEq.html" title="trait core::marker::StructuralPartialEq">StructuralPartialEq</a> for <a class="struct" href="struct.BidiInfo.html" title="struct unicode_bidi::BidiInfo">BidiInfo</a>&lt;'text&gt;</h3></section></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-BidiInfo%3C'text%3E" class="impl"><a href="#impl-Freeze-for-BidiInfo%3C'text%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'text&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.BidiInfo.html" title="struct unicode_bidi::BidiInfo">BidiInfo</a>&lt;'text&gt;</h3></section><section id="impl-RefUnwindSafe-for-BidiInfo%3C'text%3E" class="impl"><a href="#impl-RefUnwindSafe-for-BidiInfo%3C'text%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'text&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.BidiInfo.html" title="struct unicode_bidi::BidiInfo">BidiInfo</a>&lt;'text&gt;</h3></section><section id="impl-Send-for-BidiInfo%3C'text%3E" class="impl"><a href="#impl-Send-for-BidiInfo%3C'text%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'text&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.BidiInfo.html" title="struct unicode_bidi::BidiInfo">BidiInfo</a>&lt;'text&gt;</h3></section><section id="impl-Sync-for-BidiInfo%3C'text%3E" class="impl"><a href="#impl-Sync-for-BidiInfo%3C'text%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'text&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.BidiInfo.html" title="struct unicode_bidi::BidiInfo">BidiInfo</a>&lt;'text&gt;</h3></section><section id="impl-Unpin-for-BidiInfo%3C'text%3E" class="impl"><a href="#impl-Unpin-for-BidiInfo%3C'text%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'text&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.BidiInfo.html" title="struct unicode_bidi::BidiInfo">BidiInfo</a>&lt;'text&gt;</h3></section><section id="impl-UnwindSafe-for-BidiInfo%3C'text%3E" class="impl"><a href="#impl-UnwindSafe-for-BidiInfo%3C'text%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'text&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.BidiInfo.html" title="struct unicode_bidi::BidiInfo">BidiInfo</a>&lt;'text&gt;</h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/any.rs.html#140">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/any.rs.html#141">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.80.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.80.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#208">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#210">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&amp;T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#216">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#217">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&amp;mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#765">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#768">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#748-750">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#758">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
<p>That is, this conversion is whatever the implementation of
<code><a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#805-807">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#812">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#790-792">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#797">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>