16 lines
4.6 KiB
HTML
16 lines
4.6 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="Divides the string at the last index where further breaks do not depend on prior context."><title>split_at_safe in unicode_linebreak - 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_linebreak" 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 fn"><!--[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_linebreak/index.html">unicode_<wbr>linebreak</a><span class="version">0.1.5</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">split_<wbr>at_<wbr>safe</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate unicode_<wbr>linebreak</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_linebreak</a></span><h1>Function <span class="fn">split_at_safe</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_linebreak/lib.rs.html#136-147">Source</a> </span></div><pre class="rust item-decl"><code>pub fn split_at_safe(s: &<a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.str.html">str</a>) -> (&<a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.str.html">str</a>, &<a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.str.html">str</a>)</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Divides the string at the last index where further breaks do not depend on prior context.</p>
|
|
<p>The trivial index at <code>eot</code> is excluded.</p>
|
|
<p>A common optimization is to determine only the nearest line break opportunity before the first
|
|
character that would cause the line to become overfull, requiring backward traversal, of which
|
|
there are two approaches:</p>
|
|
<ul>
|
|
<li>Cache breaks from forward traversals</li>
|
|
<li>Step backward and with <code>split_at_safe</code> find a pos to safely search forward from, repeatedly</li>
|
|
</ul>
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>unicode_linebreak::{linebreaks, split_at_safe};
|
|
<span class="kw">let </span>s = <span class="string">"Not allowed to break within em dashes: — —"</span>;
|
|
<span class="kw">let </span>(prev, safe) = split_at_safe(s);
|
|
<span class="kw">let </span>n = prev.len();
|
|
<span class="macro">assert!</span>(linebreaks(safe).eq(linebreaks(s).filter_map(|(i, x)| i.checked_sub(n).map(|i| (i, x)))));</code></pre></div>
|
|
</div></details></section></div></main></body></html> |