<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="Get the base direction of the text provided according to the Unicode Bidirectional Algorithm."><title>get_base_direction 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><linkrel="stylesheet"href="../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../static.files/rustdoc-dd39b87e5fcfba68.css"><metaname="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"><scriptsrc="../static.files/storage-118b08c4c78b968e.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../static.files/main-20a3ad099b048cf2.js"></script><noscript><linkrel="stylesheet"href="../static.files/noscript-df360f571f6edeae.css"></noscript><linkrel="alternate icon"type="image/png"href="../static.files/favicon-32x32-422f7d1d52889060.png"><linkrel="icon"type="image/svg+xml"href="../static.files/favicon-2c020d218678b618.svg"></head><bodyclass="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle"title="show sidebar"></button></nav><navclass="sidebar"><divclass="sidebar-crate"><h2><ahref="../unicode_bidi/index.html">unicode_bidi</a><spanclass="version">0.3.15</span></h2></div><divclass="sidebar-elems"></div></nav><divclass="sidebar-resizer"></div><main><divclass="width-limiter"><rustdoc-search></rustdoc-search><sectionid="main-content"class="content"><divclass="main-heading"><h1>Function <ahref="index.html">unicode_bidi</a>::<wbr><aclass="fn"href="#">get_base_direction</a><buttonid="copy-path"title="Copy item path to clipboard">Copy item path</button></h1><spanclass="out-of-band"><aclass="src"href="../src/unicode_bidi/lib.rs.html#1252-1254">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><preclass="rust item-decl"><code>pub fn get_base_direction<'a, T: <aclass="trait"href="trait.TextSource.html"title="trait unicode_bidi::TextSource">TextSource</a><'a> + ?<aclass="trait"href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>>(
) -><aclass="enum"href="enum.Direction.html"title="enum unicode_bidi::Direction">Direction</a></code></pre><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>Get the base direction of the text provided according to the Unicode Bidirectional Algorithm.</p>
<p>See rules P2 and P3.</p>
<p>The base direction is derived from the first character in the string with bidi character type
L, R, or AL. If the first such character has type L, Direction::Ltr is returned. If the first
such character has type R or AL, Direction::Rtl is returned.</p>
<p>If the string does not contain any character of these types (outside of embedded isolate runs),
then Direction::Mixed is returned (but should be considered as meaning “neutral” or “unknown”,
not in fact mixed directions).</p>
<p>This is a lightweight function for use when only the base direction is needed and no further
bidi processing of the text is needed.</p>
<p>If the text contains paragraph separators, this function considers only the first paragraph.</p>
