<!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="API documentation for the Rust `Text` struct in crate `widgetry`."><metaname="keywords"content="rust, rustlang, rust-lang, Text"><title>Text in widgetry - Rust</title><linkrel="stylesheet"type="text/css"href="../normalize.css"><linkrel="stylesheet"type="text/css"href="../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../light.css"id="themeStyle"><linkrel="stylesheet"type="text/css"href="../dark.css"disabled><linkrel="stylesheet"type="text/css"href="../ayu.css"disabled><scriptid="default-settings"></script><scriptsrc="../storage.js"></script><scriptsrc="../crates.js"></script><noscript><linkrel="stylesheet"href="../noscript.css"></noscript><linkrel="icon"type="image/svg+xml"href="../favicon.svg">
<linkrel="alternate icon"type="image/png"href="../favicon-32x32.png"><styletype="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><bodyclass="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="sidebar"><divclass="sidebar-menu"role="button">☰</div><ahref='../widgetry/index.html'><divclass='logo-container rust-logo'><imgsrc='../rust-logo.png'alt='logo'></div></a><h2class="location">Struct Text</h2><divclass="sidebar-elems"><divclass="block items"><h3class="sidebar-title"><ahref="#fields">Fields</a></h3><divclass="sidebar-links"><ahref="#structfield.bg_color">bg_color</a><ahref="#structfield.lines">lines</a></div><h3class="sidebar-title"><ahref="#implementations">Methods</a></h3><divclass="sidebar-links"><ahref="#method.add_appended">add_appended</a><ahref="#method.add_line">add_line</a><ahref="#method.append">append</a><ahref="#method.append_all">append_all</a><ahref="#method.batch">batch</a><ahref="#method.bg">bg</a><ahref="#method.change_fg">change_fg</a><ahref="#method.default_fg">default_fg</a><ahref="#method.dims">dims</a><ahref="#method.extend">extend</a><ahref="#method.from_all">from_all</a><ahref="#method.from_multiline">from_multiline</a><ahref="#method.hash_key">hash_key</a><ahref="#method.highlight_last_line">highlight_last_line</a><ahref="#method.inner_render">inner_render</a><ahref="#method.inner_wrap_to_pct">inner_wrap_to_pct</a><ahref="#method.into_widget">into_widget</a><ahref="#method.is_empty">is_empty</a><ahref="#method.new">new</a><ahref="#method.render">render</a><ahref="#method.render_autocropped">render_autocropped</a><ahref="#method.tooltip">tooltip</a><ahref="#method.with_bg">with_bg</a><ahref="#method.wrap_to_pct">wrap_to_pct</a></div><h3class="sidebar-title"><ahref="#trait-implementations">Trait Implementations</a></h3><divclass="sidebar-links"><ahref="#impl-Clone">Clone</a><ahref="#impl-Debug">Debug</a><ahref="#impl-From%3CAsStrRef%3E">From<AsStrRef></a><ahref="#impl-From%3CTextSpan%3E">From<TextSpan></a></div><h3class="sidebar-title"><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><divclass="sidebar-links"><ahref="#impl-RefUnwindSafe">RefUnwindSafe</a><ahref="#impl-Send">Send</a><ahref="#impl-Sync">Sync</a><ahref="#impl-Unpin">Unpin</a><ahref="#impl-UnwindSafe">UnwindSafe</a></div><h3class="sidebar-title"><ahref="#blanket-implementations">Blanket Implementations</a></h3><divclass="sidebar-links"><ahref="#impl-Any">Any</a><ahref="#impl-Borrow%3CT%3E">Borrow<T></a><ahref="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><ahref="#impl-Downcast">Downcast</a><ahref="#impl-DowncastSync">DowncastSync</a><ahref="#impl-From%3CT%3E">From<T></a><ahref="#impl-Into%3CU%3E">Into<U></a><ahref="#impl-Same%3CT%3E">Same<T></a><ahref="#impl-ToOwned">ToOwned</a><ahref="#impl-TryFrom%3CU%3E">TryFrom<U></a><ahref="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><h2class="location">Other items in<br><ahref="index.html">widgetry</a></h2><divid="sidebar-vars"data-name="Text"data-ty="struct"data-relpath=""></div><scriptdefersrc="sidebar-items.js"></script></div></nav><divclass="theme-picker"><buttonid="theme-picker"aria-label="Pick another theme!"aria-haspopup="menu"title="themes"><imgsrc="../brush.svg"width="18"height="18"alt="Pick another theme!"></button><divid="theme-choices"role="menu"></div></div><navclass="sub"><formclass="search-form"><divclass="search-container"><div><selectid="crate-search"><optionvalue="All crates">All crates</option></select><inputclass="search-input"name="search"disabledautocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"></div><buttontype="button"id="help-button"title="help">?</button><aid="settings-menu"href="../settings.html"title="settings"><imgsrc="../wheel.svg"width="18"height="18"alt="C
</div></details><divid="method.inner_render"class="method has-srclink"><h4class="code-header">pub(crate) fn <ahref="#method.inner_render"class="fnname">inner_render</a>(self, assets: &<aclass="struct"href="assets/struct.Assets.html"title="struct widgetry::assets::Assets">Assets</a>, tolerance: <aclass="primitive"href="https://doc.rust-lang.org/1.54.0/std/primitive.f32.html">f32</a>) -><aclass="struct"href="geom/struct.GeomBatch.html"title="struct widgetry::geom::GeomBatch">GeomBatch</a></h4><ahref="#method.inner_render"class="anchor"></a><aclass="srclink"href="../src/widgetry/text.rs.html#320-374"title="goto source code">[src]</a></div><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.render_autocropped"class="method has-srclink"><h4class="code-header">pub fn <ahref="#method.render_autocropped"class="fnname">render_autocropped</a><A: <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.AsRef.html"title="trait core::convert::AsRef">AsRef</a><<aclass="struct"href="assets/struct.Assets.html"title="struct widgetry::assets::Assets">Assets</a>>>(self, assets: <aclass="primitive"href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&</a>A) -><aclass="struct"href="geom/struct.GeomBatch.html"title="struct widgetry::geom::GeomBatch">GeomBatch</a></h4><ahref="#method.render_autocropped"class="anchor"></a><aclass="srclink"href="../src/widgetry/text.rs.html#378-382"title="goto source code">[src]</a></div></summary><divclass="docblock"><p>Render the text, autocropping blank space out of the result. You can pass in an <code>EventCtx</code>
then be further <code>downcast</code> into <code>Box<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <ahref="#tymethod.into_any">Read more</a></p>
further <code>downcast</code> into <code>Rc<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <ahref="#tymethod.into_any_rc">Read more</a></p>
further <code>downcast</code> into <code>Arc<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <ahref="#tymethod.into_any_arc">Read more</a></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><divid="impl-Into%3CU%3E"class="impl has-srclink"><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.From.html"title="trait core::convert::From">From</a><T>, </span></h3><ahref="#impl-Into%3CU%3E"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#533-540"title="goto source code">[src]</a></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.into"class="method trait-impl has-srclink"><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.54.0/core/convert/trait.Into.html#tymethod.into"class="fnname">into</a>(self) -> U</h4><ahref="#method.into"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#537"title="goto source code">[src]</a></div></summary><divclass='docblock'><p>Performs the conversion.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><divid="impl-Same%3CT%3E"class="impl has-srclink"><h3class="code-header in-band">impl<T> Same<T> for T</h3><ahref="#impl-Same%3CT%3E"class="anchor"></a></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Output"class="type trait-impl has-srclink"><h4class="code-header">type <ahref="#associatedtype.Output"class="type">Output</a> = T</h4><ahref="#associatedtype.Output"class="anchor"></a></div></summary><divclass='docblock'><p>Should always be <code>Self</code></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><divid="impl-ToOwned"class="impl has-srclink"><h3class="code-header in-band">impl<T><aclass="trait"href="https://doc.rust-lang.org/1.54.0/alloc/borrow/trait.ToOwned.html"title="trait alloc::borrow::ToOwned">ToOwned</a> for T <spanclass="where fmt-newline">where<br> T: <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a>, </span></h3><ahref="#impl-ToOwned"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/alloc/borrow.rs.html#84-96"title="goto source code">[src]</a></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Owned"class="type trait-impl has-srclink"><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.54.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned"class="type">Owned</a> = T</h4><ahref="#associatedtype.Owned"class="anchor"></a></div></summary><divclass='docblock'><p>The resulting type after obtaining ownership.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.to_owned"class="method trait-impl has-srclink"><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.54.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned"class="fnname">to_owned</a>(&self) -> T</h4><ahref="#method.to_owned"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/alloc/borrow.rs.html#89"title="goto source code">[src]</a></div></summary><divclass='docblock'><p>Creates owned data from borrowed data, usually by cloning. <ahref="https://doc.rust-lang.org/1.54.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.clone_into"class="method trait-impl has-srclink"><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.54.0/alloc/borrow/trait.ToOwned.html#method.clone_into"class="fnname">clone_into</a>(&self, target: <aclass="primitive"href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&mut </a>T)</h4><ahref="#method.clone_into"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/alloc/borrow.rs.html#93"title="goto source code">[src]</a></div></summary><divclass="item-info"><divclass="stab unstable"><details><summary><spanclass="emoji">🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</summary><p>recently added</p>
</details></div></div><divclass='docblock'><p>Uses borrowed data to replace owned data, usually by cloning. <ahref="https://doc.rust-lang.org/1.54.0/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><divid="impl-TryFrom%3CU%3E"class="impl has-srclink"><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>, </span></h3><ahref="#impl-TryFrom%3CU%3E"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#581-590"title="goto source code">[src]</a></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Error"class="type trait-impl has-srclink"><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#associatedtype.Error"class="type">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/1.54.0/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></h4><ahref="#associatedtype.Error"class="anchor"></a></div></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.try_from"class="method trait-impl has-srclink"><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#tymethod.try_from"class="fnname">try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/1.54.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="type"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4><ahref="#method.try_from"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#587"title="goto source code">[src]</a></div></summary><divclass='docblock'><p>Performs the conversion.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><divid="impl-TryInto%3CU%3E"class="impl has-srclink"><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3><ahref="#impl-TryInto%3CU%3E"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#567-576"title="goto source code">[src]</a></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Error-1"class="type trait-impl has-srclink"><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryInto.html#associatedtype.Error"class="type">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></h4><ahref="#associatedtype.Error-1"class="anchor"></a></div></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.try_into"class="method trait-impl has-srclink"><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryInto.html#tymethod.try_into"class="fnname">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/1.54.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4><ahref="#method.try_into"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#573"title="goto source code">[src]</a></div></summary><divclass='docblock'><p>Performs the conversion.</p>
