edlang/unicode_bidi/trait.TextSource.html
2024-07-26 09:42:18 +00:00

10 lines
12 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="Trait that abstracts over a text source for use by the bidi algorithms. We implement this for str (UTF-8) and for u16 (UTF-16, native-endian). (For internal unicode-bidi use; API may be unstable.) This trait is sealed and cannot be implemented for types outside this crate."><title>TextSource 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 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_bidi/index.html">unicode_bidi</a><span class="version">0.3.15</span></h2></div><h2 class="location"><a href="#">TextSource</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.CharIndexIter">CharIndexIter</a></li><li><a href="#associatedtype.CharIter">CharIter</a></li><li><a href="#associatedtype.IndexLenIter">IndexLenIter</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-TextSource%3C'text%3E-for-%5Bu16%5D">[u16]</a></li><li><a href="#impl-TextSource%3C'text%3E-for-str">str</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></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>Trait <a href="index.html">unicode_bidi</a>::<wbr><a class="trait" href="#">TextSource</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#110-150">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait TextSource&lt;'text&gt;: Sealed {
type <a href="#associatedtype.CharIter" class="associatedtype">CharIter</a>: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a>&lt;Item = <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.char.html">char</a>&gt;;
type <a href="#associatedtype.CharIndexIter" class="associatedtype">CharIndexIter</a>: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a>&lt;Item = (<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.char.html">char</a>)&gt;;
type <a href="#associatedtype.IndexLenIter" class="associatedtype">IndexLenIter</a>: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a>&lt;Item = (<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</a>)&gt;;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait that abstracts over a text source for use by the bidi algorithms.
We implement this for str (UTF-8) and for <a href="https://doc.rust-lang.org/1.80.0/std/primitive.u16.html" title="primitive u16">u16</a> (UTF-16, native-endian).
(For internal unicode-bidi use; API may be unstable.)
This trait is sealed and cannot be implemented for types outside this crate.</p>
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><section id="associatedtype.CharIter" class="method"><a class="src rightside" href="../src/unicode_bidi/lib.rs.html#111">source</a><h4 class="code-header">type <a href="#associatedtype.CharIter" class="associatedtype">CharIter</a>: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a>&lt;Item = <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.char.html">char</a>&gt;</h4></section><section id="associatedtype.CharIndexIter" class="method"><a class="src rightside" href="../src/unicode_bidi/lib.rs.html#112">source</a><h4 class="code-header">type <a href="#associatedtype.CharIndexIter" class="associatedtype">CharIndexIter</a>: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a>&lt;Item = (<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.char.html">char</a>)&gt;</h4></section><section id="associatedtype.IndexLenIter" class="method"><a class="src rightside" href="../src/unicode_bidi/lib.rs.html#113">source</a><h4 class="code-header">type <a href="#associatedtype.IndexLenIter" class="associatedtype">IndexLenIter</a>: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a>&lt;Item = (<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</a>)&gt;</h4></section></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.80.0/reference/items/traits.html#object-safety">object safe</a>.</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-TextSource%3C'text%3E-for-str" class="impl"><a class="src rightside" href="../src/unicode_bidi/lib.rs.html#1313-1351">source</a><a href="#impl-TextSource%3C'text%3E-for-str" class="anchor">§</a><h3 class="code-header">impl&lt;'text&gt; <a class="trait" href="trait.TextSource.html" title="trait unicode_bidi::TextSource">TextSource</a>&lt;'text&gt; for <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a></h3></section></summary><div class="docblock"><p>Implementation of TextSource for UTF-8 text (a string slice).</p>
</div><div class="impl-items"><section id="associatedtype.CharIter-1" class="associatedtype trait-impl"><a href="#associatedtype.CharIter-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.CharIter" class="associatedtype">CharIter</a> = <a class="struct" href="https://doc.rust-lang.org/1.80.0/core/str/iter/struct.Chars.html" title="struct core::str::iter::Chars">Chars</a>&lt;'text&gt;</h4></section><section id="associatedtype.CharIndexIter-1" class="associatedtype trait-impl"><a href="#associatedtype.CharIndexIter-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.CharIndexIter" class="associatedtype">CharIndexIter</a> = <a class="struct" href="https://doc.rust-lang.org/1.80.0/core/str/iter/struct.CharIndices.html" title="struct core::str::iter::CharIndices">CharIndices</a>&lt;'text&gt;</h4></section><section id="associatedtype.IndexLenIter-1" class="associatedtype trait-impl"><a href="#associatedtype.IndexLenIter-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.IndexLenIter" class="associatedtype">IndexLenIter</a> = <a class="struct" href="struct.Utf8IndexLenIter.html" title="struct unicode_bidi::Utf8IndexLenIter">Utf8IndexLenIter</a>&lt;'text&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TextSource%3C'text%3E-for-%5Bu16%5D" class="impl"><a class="src rightside" href="../src/unicode_bidi/utf16.rs.html#621-685">source</a><a href="#impl-TextSource%3C'text%3E-for-%5Bu16%5D" class="anchor">§</a><h3 class="code-header">impl&lt;'text&gt; <a class="trait" href="trait.TextSource.html" title="trait unicode_bidi::TextSource">TextSource</a>&lt;'text&gt; for [<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u16.html">u16</a>]</h3></section></summary><div class="impl-items"><section id="associatedtype.CharIter-2" class="associatedtype trait-impl"><a href="#associatedtype.CharIter-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.CharIter" class="associatedtype">CharIter</a> = <a class="struct" href="utf16/struct.Utf16CharIter.html" title="struct unicode_bidi::utf16::Utf16CharIter">Utf16CharIter</a>&lt;'text&gt;</h4></section><section id="associatedtype.CharIndexIter-2" class="associatedtype trait-impl"><a href="#associatedtype.CharIndexIter-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.CharIndexIter" class="associatedtype">CharIndexIter</a> = <a class="struct" href="utf16/struct.Utf16CharIndexIter.html" title="struct unicode_bidi::utf16::Utf16CharIndexIter">Utf16CharIndexIter</a>&lt;'text&gt;</h4></section><section id="associatedtype.IndexLenIter-2" class="associatedtype trait-impl"><a href="#associatedtype.IndexLenIter-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.IndexLenIter" class="associatedtype">IndexLenIter</a> = <a class="struct" href="utf16/struct.Utf16IndexLenIter.html" title="struct unicode_bidi::utf16::Utf16IndexLenIter">Utf16IndexLenIter</a>&lt;'text&gt;</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_bidi/trait.TextSource.js" data-ignore-extern-crates="std" async></script></section></div></main></body></html>