mirror of
https://github.com/a-b-street/abstreet.git
synced 2024-11-24 09:24:26 +03:00
99 lines
65 KiB
HTML
99 lines
65 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 stylable UI component builder which presents vector graphics from an [`ImageSource`]."><meta name="keywords" content="rust, rustlang, rust-lang, Image"><title>Image in widgetry - 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 struct"><!--[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">☰</button><a class="sidebar-logo" href="../widgetry/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
|
||
</a><h2 class="location"></h2>
|
||
</nav>
|
||
<nav class="sidebar"><a class="sidebar-logo" href="../widgetry/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
|
||
</a><h2 class="location"><a href="#">Image</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#fields">Fields</a></h3><ul><li><a href="#structfield.bg_color">bg_color</a></li><li><a href="#structfield.color">color</a></li><li><a href="#structfield.content_mode">content_mode</a></li><li><a href="#structfield.corner_rounding">corner_rounding</a></li><li><a href="#structfield.dims">dims</a></li><li><a href="#structfield.padding">padding</a></li><li><a href="#structfield.source">source</a></li><li><a href="#structfield.tooltip">tooltip</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><ul><li><a href="#method.bg_color">bg_color</a></li><li><a href="#method.build_batch">build_batch</a></li><li><a href="#method.color">color</a></li><li><a href="#method.content_mode">content_mode</a></li><li><a href="#method.corner_rounding">corner_rounding</a></li><li><a href="#method.dims">dims</a></li><li><a href="#method.empty">empty</a></li><li><a href="#method.from_batch">from_batch</a></li><li><a href="#method.from_bytes">from_bytes</a></li><li><a href="#method.from_path">from_path</a></li><li><a href="#method.into_widget">into_widget</a></li><li><a href="#method.merged_image_style">merged_image_style</a></li><li><a href="#method.padding">padding</a></li><li><a href="#method.padding_bottom">padding_bottom</a></li><li><a href="#method.padding_left">padding_left</a></li><li><a href="#method.padding_right">padding_right</a></li><li><a href="#method.padding_top">padding_top</a></li><li><a href="#method.source">source</a></li><li><a href="#method.source_batch">source_batch</a></li><li><a href="#method.source_bytes">source_bytes</a></li><li><a href="#method.source_path">source_path</a></li><li><a href="#method.tooltip">tooltip</a></li><li><a href="#method.untinted">untinted</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><ul><li><a href="#impl-Clone">Clone</a></li><li><a href="#impl-Debug">Debug</a></li><li><a href="#impl-Default">Default</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul><li><a href="#impl-RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send">Send</a></li><li><a href="#impl-Sync">Sync</a></li><li><a href="#impl-Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe">UnwindSafe</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#blanket-implementations">Blanket Implementations</a></h3><ul><li><a href="#impl-Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a></li><li><a href="#impl-Downcast">Downcast</a></li><li><a href="#impl-DowncastSync">DowncastSync</a></li><li><a href="#impl-From%3CT%3E">From<T></a></li><li><a href="#impl-Instrument">Instrument</a></li><li><a href="#impl-Into%3CU%3E">Into<U></a></li><li><a href="#impl-ToOwned">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E">TryInto<U></a></li></ul></div></section><h2 class="location"><a href="index.html">In widgetry</a></h2><div id="sidebar-vars" data-name="Image" data-ty="struct" 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="../widgetry/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
|
||
<h1 class="fqn"><span class="in-band">Struct <a href="index.html">widgetry</a>::<wbr><a class="struct" href="#">Image</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></h1><span class="out-of-band"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#11-20">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust struct"><code>pub struct Image<'a, 'c> {
|
||
source: <a class="enum" href="https://doc.rust-lang.org/1.62.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/1.62.1/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'c, <a class="enum" href="widgets/image/enum.ImageSource.html" title="enum widgetry::widgets::image::ImageSource">ImageSource</a><'a>>>,
|
||
tooltip: <a class="enum" href="https://doc.rust-lang.org/1.62.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="text/struct.Text.html" title="struct widgetry::text::Text">Text</a>>,
|
||
color: <a class="enum" href="https://doc.rust-lang.org/1.62.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="geom/enum.RewriteColor.html" title="enum widgetry::geom::RewriteColor">RewriteColor</a>>,
|
||
content_mode: <a class="enum" href="https://doc.rust-lang.org/1.62.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="enum.ContentMode.html" title="enum widgetry::ContentMode">ContentMode</a>>,
|
||
corner_rounding: <a class="enum" href="https://doc.rust-lang.org/1.62.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="widgets/enum.CornerRounding.html" title="enum widgetry::widgets::CornerRounding">CornerRounding</a>>,
|
||
padding: <a class="enum" href="https://doc.rust-lang.org/1.62.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="widgets/struct.EdgeInsets.html" title="struct widgetry::widgets::EdgeInsets">EdgeInsets</a>>,
|
||
bg_color: <a class="enum" href="https://doc.rust-lang.org/1.62.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="color/struct.Color.html" title="struct widgetry::color::Color">Color</a>>,
|
||
dims: <a class="enum" href="https://doc.rust-lang.org/1.62.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="screen_geom/struct.ScreenDims.html" title="struct widgetry::screen_geom::ScreenDims">ScreenDims</a>>,
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A stylable UI component builder which presents vector graphics from an <a href="widgets/image/enum.ImageSource.html" title="ImageSource"><code>ImageSource</code></a>.</p>
|
||
</div></details><h2 id="fields" class="fields small-section-header">Fields<a href="#fields" class="anchor"></a></h2><span id="structfield.source" class="structfield small-section-header"><a href="#structfield.source" class="anchor field"></a><code>source: <a class="enum" href="https://doc.rust-lang.org/1.62.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/1.62.1/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'c, <a class="enum" href="widgets/image/enum.ImageSource.html" title="enum widgetry::widgets::image::ImageSource">ImageSource</a><'a>>></code></span><span id="structfield.tooltip" class="structfield small-section-header"><a href="#structfield.tooltip" class="anchor field"></a><code>tooltip: <a class="enum" href="https://doc.rust-lang.org/1.62.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="text/struct.Text.html" title="struct widgetry::text::Text">Text</a>></code></span><span id="structfield.color" class="structfield small-section-header"><a href="#structfield.color" class="anchor field"></a><code>color: <a class="enum" href="https://doc.rust-lang.org/1.62.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="geom/enum.RewriteColor.html" title="enum widgetry::geom::RewriteColor">RewriteColor</a>></code></span><span id="structfield.content_mode" class="structfield small-section-header"><a href="#structfield.content_mode" class="anchor field"></a><code>content_mode: <a class="enum" href="https://doc.rust-lang.org/1.62.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="enum.ContentMode.html" title="enum widgetry::ContentMode">ContentMode</a>></code></span><span id="structfield.corner_rounding" class="structfield small-section-header"><a href="#structfield.corner_rounding" class="anchor field"></a><code>corner_rounding: <a class="enum" href="https://doc.rust-lang.org/1.62.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="widgets/enum.CornerRounding.html" title="enum widgetry::widgets::CornerRounding">CornerRounding</a>></code></span><span id="structfield.padding" class="structfield small-section-header"><a href="#structfield.padding" class="anchor field"></a><code>padding: <a class="enum" href="https://doc.rust-lang.org/1.62.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="widgets/struct.EdgeInsets.html" title="struct widgetry::widgets::EdgeInsets">EdgeInsets</a>></code></span><span id="structfield.bg_color" class="structfield small-section-header"><a href="#structfield.bg_color" class="anchor field"></a><code>bg_color: <a class="enum" href="https://doc.rust-lang.org/1.62.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="color/struct.Color.html" title="struct widgetry::color::Color">Color</a>></code></span><span id="structfield.dims" class="structfield small-section-header"><a href="#structfield.dims" class="anchor field"></a><code>dims: <a class="enum" href="https://doc.rust-lang.org/1.62.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="screen_geom/struct.ScreenDims.html" title="struct widgetry::screen_geom::ScreenDims">ScreenDims</a>></code></span><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#54-342">source</a></span><a href="#impl" class="anchor"></a><h3 class="code-header in-band">impl<'a, 'c> <a class="struct" href="widgets/image/struct.Image.html" title="struct widgetry::widgets::image::Image">Image</a><'a, 'c></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.empty" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#57-61">source</a></span><a href="#method.empty" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.empty" class="fnname">empty</a>() -> Self</h4></section></summary><div class="docblock"><p>An <code>Image</code> with no renderable content. Useful for starting a template for creating
|
||
several similar images using a builder pattern.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_path" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#64-69">source</a></span><a href="#method.from_path" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.from_path" class="fnname">from_path</a>(filename: &'a <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.str.html">str</a>) -> Self</h4></section></summary><div class="docblock"><p>Create an SVG <code>Image</code>, read from <code>filename</code>, which is colored to match <code>Style.icon_fg</code></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_bytes" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#77-85">source</a></span><a href="#method.from_bytes" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.from_bytes" class="fnname">from_bytes</a>(labeled_bytes: <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.tuple.html">(</a>&'a <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.str.html">str</a>, <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.slice.html">]</a><a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.tuple.html">)</a>) -> Self</h4></section></summary><div class="docblock"><p>Create a new SVG <code>Image</code> from bytes.</p>
|
||
<ul>
|
||
<li><code>labeled_bytes</code>: is a (<code>label</code>, <code>bytes</code>) tuple you can generate with
|
||
<a href="macro.include_labeled_bytes.html" title="include_labeled_bytes!"><code>include_labeled_bytes!</code></a></li>
|
||
<li><code>label</code>: a label to describe the bytes for debugging purposes</li>
|
||
<li><code>bytes</code>: UTF-8 encoded bytes of the SVG</li>
|
||
</ul>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_batch" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#90-96">source</a></span><a href="#method.from_batch" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.from_batch" class="fnname">from_batch</a>(batch: <a class="struct" href="geom/struct.GeomBatch.html" title="struct widgetry::geom::GeomBatch">GeomBatch</a>, bounds: <a class="struct" href="../geom/bounds/struct.Bounds.html" title="struct geom::bounds::Bounds">Bounds</a>) -> Self</h4></section></summary><div class="docblock"><p>Create a new <code>Image</code> from a <a href="geom/struct.GeomBatch.html" title="GeomBatch"><code>GeomBatch</code></a>.</p>
|
||
<p>By default, the given <code>bounds</code> will be used for padding, background, etc.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.source" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#101-104">source</a></span><a href="#method.source" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.source" class="fnname">source</a>(self, source: <a class="enum" href="widgets/image/enum.ImageSource.html" title="enum widgetry::widgets::image::ImageSource">ImageSource</a><'a>) -> Self</h4></section></summary><div class="docblock"><p>Set a new source for the <code>Image</code>’s data.</p>
|
||
<p>This will replace any previously set source.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.source_path" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#109-111">source</a></span><a href="#method.source_path" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.source_path" class="fnname">source_path</a>(self, path: &'a <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.str.html">str</a>) -> Self</h4></section></summary><div class="docblock"><p>Set the path to an SVG file for the image.</p>
|
||
<p>This will replace any image source previously set.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.source_bytes" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#121-127">source</a></span><a href="#method.source_bytes" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.source_bytes" class="fnname">source_bytes</a>(self, labeled_bytes: <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.tuple.html">(</a>&'a <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.str.html">str</a>, <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.slice.html">]</a><a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.tuple.html">)</a>) -> Self</h4></section></summary><div class="docblock"><p>Set the bytes for the image.</p>
|
||
<p>This will replace any image source previously set.</p>
|
||
<ul>
|
||
<li><code>labeled_bytes</code>: is a (<code>label</code>, <code>bytes</code>) tuple you can generate with
|
||
<a href="macro.include_labeled_bytes.html" title="include_labeled_bytes!"><code>include_labeled_bytes!</code></a></li>
|
||
<li><code>label</code>: a label to describe the bytes for debugging purposes</li>
|
||
<li><code>bytes</code>: UTF-8 encoded bytes of the SVG</li>
|
||
</ul>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.source_batch" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#135-137">source</a></span><a href="#method.source_batch" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.source_batch" class="fnname">source_batch</a>(self, batch: <a class="struct" href="geom/struct.GeomBatch.html" title="struct widgetry::geom::GeomBatch">GeomBatch</a>, bounds: <a class="struct" href="../geom/bounds/struct.Bounds.html" title="struct geom::bounds::Bounds">Bounds</a>) -> Self</h4></section></summary><div class="docblock"><p>Set the GeomBatch for the button.</p>
|
||
<p>This will replace any image source previously set.</p>
|
||
<p>This method is useful when doing more complex transforms. For example, to re-write more than
|
||
one color for your image, do so externally and pass in the resultant GeomBatch here.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.tooltip" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#140-143">source</a></span><a href="#method.tooltip" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.tooltip" class="fnname">tooltip</a>(self, tooltip: impl <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="text/struct.Text.html" title="struct widgetry::text::Text">Text</a>>) -> Self</h4></section></summary><div class="docblock"><p>Add a tooltip to appear when hovering over the image.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.merged_image_style" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#146-165">source</a></span><a href="#method.merged_image_style" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.merged_image_style" class="fnname">merged_image_style</a>(&'c self, other: <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.reference.html">&'c </a>Self) -> Self</h4></section></summary><div class="docblock"><p>Create a new <code>Image</code> based on <code>self</code>, but overriding with any values set on <code>other</code>.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.color" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#168-171">source</a></span><a href="#method.color" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.color" class="fnname">color</a><RWC: <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="geom/enum.RewriteColor.html" title="enum widgetry::geom::RewriteColor">RewriteColor</a>>>(self, value: RWC) -> Self</h4></section></summary><div class="docblock"><p>Rewrite the color of the image.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.bg_color" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#174-177">source</a></span><a href="#method.bg_color" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.bg_color" class="fnname">bg_color</a>(self, value: <a class="struct" href="color/struct.Color.html" title="struct widgetry::color::Color">Color</a>) -> Self</h4></section></summary><div class="docblock"><p>Set a background color for the image. Has no effect unless custom <code>dims</code> are explicitly set.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.untinted" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#180-182">source</a></span><a href="#method.untinted" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.untinted" class="fnname">untinted</a>(self) -> Self</h4></section></summary><div class="docblock"><p>The image’s intrinsic colors will be used, it will not be tinted like <code>Image::icon</code></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.dims" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#188-191">source</a></span><a href="#method.dims" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.dims" class="fnname">dims</a><D: <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="screen_geom/struct.ScreenDims.html" title="struct widgetry::screen_geom::ScreenDims">ScreenDims</a>>>(self, dims: D) -> Self</h4></section></summary><div class="docblock"><p>Scale the bounds containing the image. If <code>dims</code> are not specified, the image’s intrinsic
|
||
size will be used, but padding and background settings will be ignored.</p>
|
||
<p>See <a href="widgets/image/struct.Image.html#method.content_mode" title="Self::content_mode"><code>Self::content_mode</code></a> to control how the image scales to fit its custom bounds.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.content_mode" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#200-203">source</a></span><a href="#method.content_mode" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.content_mode" class="fnname">content_mode</a>(self, value: <a class="enum" href="enum.ContentMode.html" title="enum widgetry::ContentMode">ContentMode</a>) -> Self</h4></section></summary><div class="docblock"><p>If a custom <code>dims</code> was set, control how the image should be scaled to its new bounds.</p>
|
||
<p>If <code>dims</code> were not specified, the image will not be scaled, so content_mode has no
|
||
affect.</p>
|
||
<p>The default, <a href="enum.ContentMode.html#variant.ScaleAspectFit" title="ContentMode::ScaleAspectFit"><code>ContentMode::ScaleAspectFit</code></a> will only grow as much as it can while
|
||
maintaining its aspect ratio and not exceeding its bounds</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.corner_rounding" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#207-210">source</a></span><a href="#method.corner_rounding" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.corner_rounding" class="fnname">corner_rounding</a><R: <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="widgets/enum.CornerRounding.html" title="enum widgetry::widgets::CornerRounding">CornerRounding</a>>>(self, value: R) -> Self</h4></section></summary><div class="docblock"><p>Set independent rounding for each of the image’s corners. Has no effect unless custom
|
||
<code>dims</code> are explicitly set.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.padding" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#213-216">source</a></span><a href="#method.padding" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.padding" class="fnname">padding</a><EI: <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="widgets/struct.EdgeInsets.html" title="struct widgetry::widgets::EdgeInsets">EdgeInsets</a>>>(self, value: EI) -> Self</h4></section></summary><div class="docblock"><p>Set padding for the image. Has no effect unless custom <code>dims</code> are explicitly set.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.padding_top" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#219-224">source</a></span><a href="#method.padding_top" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.padding_top" class="fnname">padding_top</a>(self, new_value: <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.f64.html">f64</a>) -> Self</h4></section></summary><div class="docblock"><p>Padding above the image. Has no effect unless custom <code>dims</code> are explicitly set.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.padding_left" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#227-232">source</a></span><a href="#method.padding_left" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.padding_left" class="fnname">padding_left</a>(self, new_value: <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.f64.html">f64</a>) -> Self</h4></section></summary><div class="docblock"><p>Padding to the left of the image. Has no effect unless custom <code>dims</code> are explicitly set.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.padding_bottom" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#235-240">source</a></span><a href="#method.padding_bottom" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.padding_bottom" class="fnname">padding_bottom</a>(self, new_value: <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.f64.html">f64</a>) -> Self</h4></section></summary><div class="docblock"><p>Padding below the image. Has no effect unless custom <code>dims</code> are explicitly set.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.padding_right" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#243-248">source</a></span><a href="#method.padding_right" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.padding_right" class="fnname">padding_right</a>(self, new_value: <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.f64.html">f64</a>) -> Self</h4></section></summary><div class="docblock"><p>Padding to the right of the image. Has no effect unless custom <code>dims</code> are explicitly set.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.build_batch" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#251-319">source</a></span><a href="#method.build_batch" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.build_batch" class="fnname">build_batch</a>(&self, ctx: &<a class="struct" href="event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/1.62.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.tuple.html">(</a><a class="struct" href="geom/struct.GeomBatch.html" title="struct widgetry::geom::GeomBatch">GeomBatch</a>, <a class="struct" href="../geom/bounds/struct.Bounds.html" title="struct geom::bounds::Bounds">Bounds</a><a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.tuple.html">)</a>></h4></section></summary><div class="docblock"><p>Render the <code>Image</code> and any styling (padding, background, etc.) to a <code>GeomBatch</code>.</p>
|
||
</div></details><section id="method.into_widget" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#321-341">source</a></span><a href="#method.into_widget" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.into_widget" class="fnname">into_widget</a>(self, ctx: &<a class="struct" href="event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a><'_>) -> <a class="struct" href="widgets/struct.Widget.html" title="struct widgetry::widgets::Widget">Widget</a></h4></section></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#10">source</a></span><a href="#impl-Clone" class="anchor"></a><h3 class="code-header in-band">impl<'a, 'c> <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="widgets/image/struct.Image.html" title="struct widgetry::widgets::image::Image">Image</a><'a, 'c></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#10">source</a></span><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.62.1/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> <a class="struct" href="widgets/image/struct.Image.html" title="struct widgetry::widgets::image::Image">Image</a><'a, 'c></h4></section></summary><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.62.1/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/1.62.1/src/core/clone.rs.html#133-135">source</a></span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.62.1/core/clone/trait.Clone.html#method.clone_from" class="fnname">clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.reference.html">&</a>Self)</h4></section></summary><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.62.1/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#10">source</a></span><a href="#impl-Debug" class="anchor"></a><h3 class="code-header in-band">impl<'a, 'c> <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="widgets/image/struct.Image.html" title="struct widgetry::widgets::image::Image">Image</a><'a, 'c></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#10">source</a></span><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.62.1/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.62.1/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.62.1/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.62.1/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Default" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#10">source</a></span><a href="#impl-Default" class="anchor"></a><h3 class="code-header in-band">impl<'a, 'c> <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="widgets/image/struct.Image.html" title="struct widgetry::widgets::image::Image">Image</a><'a, 'c></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.default" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/widgets/image.rs.html#10">source</a></span><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.62.1/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> <a class="struct" href="widgets/image/struct.Image.html" title="struct widgetry::widgets::image::Image">Image</a><'a, 'c></h4></section></summary><div class='docblock'><p>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.62.1/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||
</div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe" class="impl has-srclink"><a href="#impl-RefUnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl<'a, 'c> <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="widgets/image/struct.Image.html" title="struct widgetry::widgets::image::Image">Image</a><'a, 'c></h3></section><section id="impl-Send" class="impl has-srclink"><a href="#impl-Send" class="anchor"></a><h3 class="code-header in-band">impl<'a, 'c> <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="widgets/image/struct.Image.html" title="struct widgetry::widgets::image::Image">Image</a><'a, 'c></h3></section><section id="impl-Sync" class="impl has-srclink"><a href="#impl-Sync" class="anchor"></a><h3 class="code-header in-band">impl<'a, 'c> <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="widgets/image/struct.Image.html" title="struct widgetry::widgets::image::Image">Image</a><'a, 'c></h3></section><section id="impl-Unpin" class="impl has-srclink"><a href="#impl-Unpin" class="anchor"></a><h3 class="code-header in-band">impl<'a, 'c> <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="widgets/image/struct.Image.html" title="struct widgetry::widgets::image::Image">Image</a><'a, 'c> <span class="where fmt-newline">where<br> 'a: 'c, </span></h3></section><section id="impl-UnwindSafe" class="impl has-srclink"><a href="#impl-UnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl<'a, 'c> <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="widgets/image/struct.Image.html" title="struct widgetry::widgets::image::Image">Image</a><'a, 'c></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.62.1/src/core/any.rs.html#132-136">source</a></span><a href="#impl-Any" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.62.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.62.1/src/core/any.rs.html#133">source</a></span><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.62.1/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.62.1/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.62.1/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.62.1/src/core/borrow.rs.html#209-214">source</a></span><a href="#impl-Borrow%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.62.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.62.1/src/core/borrow.rs.html#211">source</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.62.1/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.reference.html">&</a>T</h4></section></summary><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.62.1/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.62.1/src/core/borrow.rs.html#218-222">source</a></span><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.62.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.62.1/src/core/borrow.rs.html#219">source</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.62.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.reference.html">&mut </a>T</h4></section></summary><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.62.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Downcast" class="impl has-srclink"><a href="#impl-Downcast" class="anchor"></a><h3 class="code-header in-band">impl<T> Downcast for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_any" class="method trait-impl has-srclink"><a href="#method.into_any" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into_any</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.62.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><T, <a class="struct" href="https://doc.rust-lang.org/1.62.1/alloc/alloc/struct.Global.html" title="struct alloc::alloc::Global">Global</a>>) -> <a class="struct" href="https://doc.rust-lang.org/1.62.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + 'static, <a class="struct" href="https://doc.rust-lang.org/1.62.1/alloc/alloc/struct.Global.html" title="struct alloc::alloc::Global">Global</a>></h4></section></summary><div class='docblock'><p>Convert <code>Box<dyn Trait></code> (where <code>Trait: Downcast</code>) to <code>Box<dyn Any></code>. <code>Box<dyn Any></code> can
|
||
then be further <code>downcast</code> into <code>Box<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <a>Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_any_rc" class="method trait-impl has-srclink"><a href="#method.into_any_rc" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into_any_rc</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.62.1/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><T>) -> <a class="struct" href="https://doc.rust-lang.org/1.62.1/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + 'static></h4></section></summary><div class='docblock'><p>Convert <code>Rc<Trait></code> (where <code>Trait: Downcast</code>) to <code>Rc<Any></code>. <code>Rc<Any></code> can then be
|
||
further <code>downcast</code> into <code>Rc<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <a>Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_any" class="method trait-impl has-srclink"><a href="#method.as_any" class="anchor"></a><h4 class="code-header">fn <a class="fnname">as_any</a>(&self) -> &(dyn <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + 'static)</h4></section></summary><div class='docblock'><p>Convert <code>&Trait</code> (where <code>Trait: Downcast</code>) to <code>&Any</code>. This is needed since Rust cannot
|
||
generate <code>&Any</code>’s vtable from <code>&Trait</code>’s. <a>Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_any_mut" class="method trait-impl has-srclink"><a href="#method.as_any_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">as_any_mut</a>(&mut self) -> &mut (dyn <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + 'static)</h4></section></summary><div class='docblock'><p>Convert <code>&mut Trait</code> (where <code>Trait: Downcast</code>) to <code>&Any</code>. This is needed since Rust cannot
|
||
generate <code>&mut Any</code>’s vtable from <code>&mut Trait</code>’s. <a>Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-DowncastSync" class="impl has-srclink"><a href="#impl-DowncastSync" class="anchor"></a><h3 class="code-header in-band">impl<T> DowncastSync for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_any_arc" class="method trait-impl has-srclink"><a href="#method.into_any_arc" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into_any_arc</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.62.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><T>) -> <a class="struct" href="https://doc.rust-lang.org/1.62.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static></h4></section></summary><div class='docblock'><p>Convert <code>Arc<Trait></code> (where <code>Trait: Downcast</code>) to <code>Arc<Any></code>. <code>Arc<Any></code> can then be
|
||
further <code>downcast</code> into <code>Arc<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <a>Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.62.1/src/core/convert/mod.rs.html#557-562">source</a></span><a href="#impl-From%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.62.1/src/core/convert/mod.rs.html#559">source</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.62.1/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Instrument" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://docs.rs/tracing/0.1.26/src/tracing/instrument.rs.html#155">source</a></span><a href="#impl-Instrument" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://docs.rs/tracing/0.1.26/tracing/instrument/trait.Instrument.html" title="trait tracing::instrument::Instrument">Instrument</a> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.instrument" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://docs.rs/tracing/0.1.26/src/tracing/instrument.rs.html#38">source</a></span><a href="#method.instrument" class="anchor"></a><h4 class="code-header">fn <a href="https://docs.rs/tracing/0.1.26/tracing/instrument/trait.Instrument.html#method.instrument" class="fnname">instrument</a>(self, span: <a class="struct" href="https://docs.rs/tracing/0.1.26/tracing/span/struct.Span.html" title="struct tracing::span::Span">Span</a>) -> <a class="struct" href="https://docs.rs/tracing/0.1.26/tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><div class='docblock'><p>Instruments this type with the provided <code>Span</code>, returning an
|
||
<code>Instrumented</code> wrapper. <a href="https://docs.rs/tracing/0.1.26/tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.in_current_span" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://docs.rs/tracing/0.1.26/src/tracing/instrument.rs.html#74">source</a></span><a href="#method.in_current_span" class="anchor"></a><h4 class="code-header">fn <a href="https://docs.rs/tracing/0.1.26/tracing/instrument/trait.Instrument.html#method.in_current_span" class="fnname">in_current_span</a>(self) -> <a class="struct" href="https://docs.rs/tracing/0.1.26/tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><div class='docblock'><p>Instruments this type with the <a href="../struct.Span.html#method.current">current</a> <code>Span</code>, returning an
|
||
<code>Instrumented</code> wrapper. <a href="https://docs.rs/tracing/0.1.26/tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.62.1/src/core/convert/mod.rs.html#541-552">source</a></span><a href="#impl-Into%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.62.1/src/core/convert/mod.rs.html#549">source</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.62.1/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
<p>That is, this conversion is whatever the implementation of
|
||
<code><a href="https://doc.rust-lang.org/1.62.1/core/convert/trait.From.html" title="From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.62.1/src/alloc/borrow.rs.html#84-96">source</a></span><a href="#impl-ToOwned" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.62.1/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.62.1/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'><p>The resulting type after obtaining ownership.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.62.1/src/alloc/borrow.rs.html#89">source</a></span><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.62.1/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fnname">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/1.62.1/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.62.1/src/alloc/borrow.rs.html#93">source</a></span><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.62.1/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fnname">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.reference.html">&mut </a>T)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</div></span><div class='docblock'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/1.62.1/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.62.1/src/core/convert/mod.rs.html#598-607">source</a></span><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.62.1/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.62.1/src/core/convert/mod.rs.html#604">source</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.62.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.62.1/src/core/convert/mod.rs.html#583-592">source</a></span><a href="#impl-TryInto%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.62.1/src/core/convert/mod.rs.html#589">source</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.62.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="widgetry" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.62.1 (e092d0b6b 2022-07-16)" ></div>
|
||
</body></html> |