21 lines
8.8 KiB
HTML
21 lines
8.8 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="A (text) fragment denotes the unit which we wrap into lines."><meta name="keywords" content="rust, rustlang, rust-lang, Fragment"><title>Fragment in textwrap::core - 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" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.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="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../../textwrap/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></div>
|
||
</a><h2 class="location">Trait Fragment</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><div class="sidebar-links"><a href="#tymethod.penalty_width">penalty_width</a><a href="#tymethod.whitespace_width">whitespace_width</a><a href="#tymethod.width">width</a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="../index.html">textwrap</a>::<wbr><a href="index.html">core</a></h2><div id="sidebar-vars" data-name="Fragment" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../textwrap/index.html"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="../index.html">textwrap</a>::<wbr><a href="index.html">core</a>::<wbr><a class="trait" href="#">Fragment</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></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/textwrap/core.rs.html#197-208" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust trait"><code>pub trait Fragment: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> {
|
||
fn <a href="#tymethod.width" class="fnname">width</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.f64.html">f64</a>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.whitespace_width" class="fnname">whitespace_width</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.f64.html">f64</a>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.penalty_width" class="fnname">penalty_width</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.f64.html">f64</a>;
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A (text) fragment denotes the unit which we wrap into lines.</p>
|
||
<p>Fragments represent an abstract <em>word</em> plus the <em>whitespace</em>
|
||
following the word. In case the word falls at the end of the line,
|
||
the whitespace is dropped and a so-called <em>penalty</em> is inserted
|
||
instead (typically <code>"-"</code> if the word was hyphenated).</p>
|
||
<p>For wrapping purposes, the precise content of the word, the
|
||
whitespace, and the penalty is irrelevant. All we need to know is
|
||
the displayed width of each part, which this trait provides.</p>
|
||
</div></details><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.width" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/textwrap/core.rs.html#199" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.width" class="fnname">width</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.f64.html">f64</a></h4></div></summary><div class="docblock"><p>Displayed width of word represented by this fragment.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.whitespace_width" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/textwrap/core.rs.html#203" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.whitespace_width" class="fnname">whitespace_width</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.f64.html">f64</a></h4></div></summary><div class="docblock"><p>Displayed width of the whitespace that must follow the word
|
||
when the word is not at the end of a line.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.penalty_width" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/textwrap/core.rs.html#207" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.penalty_width" class="fnname">penalty_width</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.f64.html">f64</a></h4></div></summary><div class="docblock"><p>Displayed width of the penalty that must be inserted if the
|
||
word falls at the end of a line.</p>
|
||
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><div id="impl-Fragment" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/textwrap/core.rs.html#304-323" title="goto source code">[src]</a></div><a href="#impl-Fragment" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.Fragment.html" title="trait textwrap::core::Fragment">Fragment</a> for <a class="struct" href="struct.Word.html" title="struct textwrap::core::Word">Word</a><'_></h3></div></div><script type="text/javascript" src="../../implementors/textwrap/core/trait.Fragment.js" async></script></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="textwrap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |