70 lines
31 KiB
HTML
70 lines
31 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="Creates text to be added to a plot"><title>Text in plotpy - 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="plotpy" 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 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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../plotpy/index.html">plotpy</a><span class="version">0.5.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Text</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example" title="Example">Example</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.draw" title="draw">draw</a></li><li><a href="#method.draw_3d" title="draw_3d">draw_3d</a></li><li><a href="#method.new" title="new">new</a></li><li><a href="#method.set_align_horizontal" title="set_align_horizontal">set_align_horizontal</a></li><li><a href="#method.set_align_vertical" title="set_align_vertical">set_align_vertical</a></li><li><a href="#method.set_bbox" title="set_bbox">set_bbox</a></li><li><a href="#method.set_bbox_alpha" title="set_bbox_alpha">set_bbox_alpha</a></li><li><a href="#method.set_bbox_edgecolor" title="set_bbox_edgecolor">set_bbox_edgecolor</a></li><li><a href="#method.set_bbox_facecolor" title="set_bbox_facecolor">set_bbox_facecolor</a></li><li><a href="#method.set_bbox_style" title="set_bbox_style">set_bbox_style</a></li><li><a href="#method.set_color" title="set_color">set_color</a></li><li><a href="#method.set_fontsize" title="set_fontsize">set_fontsize</a></li><li><a href="#method.set_rotation" title="set_rotation">set_rotation</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-GraphMaker-for-Text" title="GraphMaker">GraphMaker</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-Text" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-Text" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Text" title="Send">Send</a></li><li><a href="#impl-Sync-for-Text" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-Text" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Text" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow<T>">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut<T>">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-T" title="From<T>">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into<U>">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom<U>">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto<U>">TryInto<U></a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate plotpy</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">plotpy</a></span><h1>Struct <span class="struct">Text</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/plotpy/text.rs.html#40-57">Source</a> </span></div><pre class="rust item-decl"><code>pub struct Text { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Creates text to be added to a plot</p>
|
|
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>plotpy::{Plot, Text, StrError};
|
|
<span class="kw">use </span>std::path::Path;
|
|
|
|
<span class="kw">fn </span>main() -> <span class="prelude-ty">Result</span><(), StrError> {
|
|
<span class="comment">// configure text
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>text = Text::new();
|
|
text.set_color(<span class="string">"purple"</span>)
|
|
.set_align_horizontal(<span class="string">"center"</span>)
|
|
.set_align_vertical(<span class="string">"center"</span>)
|
|
.set_fontsize(<span class="number">30.0</span>)
|
|
.set_rotation(<span class="number">45.0</span>)
|
|
.set_bbox(<span class="bool-val">true</span>)
|
|
.set_bbox_facecolor(<span class="string">"pink"</span>)
|
|
.set_bbox_edgecolor(<span class="string">"black"</span>)
|
|
.set_bbox_alpha(<span class="number">0.3</span>)
|
|
.set_bbox_style(<span class="string">"roundtooth,pad=0.3,tooth_size=0.2"</span>);
|
|
|
|
<span class="comment">// draw text
|
|
</span>text.draw_3d(<span class="number">0.5</span>, <span class="number">0.5</span>, <span class="number">0.5</span>, <span class="string">"Hello World!"</span>);
|
|
|
|
<span class="comment">// add text to plot
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>plot = Plot::new();
|
|
plot.add(<span class="kw-2">&</span>text);
|
|
|
|
<span class="comment">// save figure
|
|
</span>plot.save(<span class="string">"/tmp/plotpy/doc_tests/doc_text.svg"</span>)<span class="question-mark">?</span>;
|
|
<span class="prelude-val">Ok</span>(())
|
|
}</code></pre></div>
|
|
<p><img src="https://raw.githubusercontent.com/cpmech/plotpy/main/figures/doc_text.svg" alt="doc_text.svg" /></p>
|
|
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Text" class="impl"><a class="src rightside" href="../src/plotpy/text.rs.html#59-217">Source</a><a href="#impl-Text" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.Text.html" title="struct plotpy::Text">Text</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../src/plotpy/text.rs.html#61-75">Source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>() -> Self</h4></section></summary><div class="docblock"><p>Creates a new Text object</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.draw" class="method"><a class="src rightside" href="../src/plotpy/text.rs.html#78-85">Source</a><h4 class="code-header">pub fn <a href="#method.draw" class="fn">draw</a>(&mut self, x: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f64.html">f64</a>, y: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f64.html">f64</a>, message: &<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.str.html">str</a>)</h4></section></summary><div class="docblock"><p>Draws text</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.draw_3d" class="method"><a class="src rightside" href="../src/plotpy/text.rs.html#88-101">Source</a><h4 class="code-header">pub fn <a href="#method.draw_3d" class="fn">draw_3d</a>(&mut self, x: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f64.html">f64</a>, y: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f64.html">f64</a>, z: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f64.html">f64</a>, message: &<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.str.html">str</a>)</h4></section></summary><div class="docblock"><p>Draws text in 3D plot</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_color" class="method"><a class="src rightside" href="../src/plotpy/text.rs.html#104-107">Source</a><h4 class="code-header">pub fn <a href="#method.set_color" class="fn">set_color</a>(&mut self, color: &<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.str.html">str</a>) -> &mut Self</h4></section></summary><div class="docblock"><p>Sets the text color</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_align_horizontal" class="method"><a class="src rightside" href="../src/plotpy/text.rs.html#112-115">Source</a><h4 class="code-header">pub fn <a href="#method.set_align_horizontal" class="fn">set_align_horizontal</a>(&mut self, option: &<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.str.html">str</a>) -> &mut Self</h4></section></summary><div class="docblock"><p>Sets the horizontal alignment</p>
|
|
<p>Options: “center”, “left”, “right”</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_align_vertical" class="method"><a class="src rightside" href="../src/plotpy/text.rs.html#120-123">Source</a><h4 class="code-header">pub fn <a href="#method.set_align_vertical" class="fn">set_align_vertical</a>(&mut self, option: &<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.str.html">str</a>) -> &mut Self</h4></section></summary><div class="docblock"><p>Sets the vertical alignment</p>
|
|
<p>Options: “center”, “top”, “bottom”, “baseline”, “center_baseline”</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_fontsize" class="method"><a class="src rightside" href="../src/plotpy/text.rs.html#126-129">Source</a><h4 class="code-header">pub fn <a href="#method.set_fontsize" class="fn">set_fontsize</a>(&mut self, fontsize: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f64.html">f64</a>) -> &mut Self</h4></section></summary><div class="docblock"><p>Sets the font size</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_rotation" class="method"><a class="src rightside" href="../src/plotpy/text.rs.html#132-135">Source</a><h4 class="code-header">pub fn <a href="#method.set_rotation" class="fn">set_rotation</a>(&mut self, rotation: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f64.html">f64</a>) -> &mut Self</h4></section></summary><div class="docblock"><p>Sets the text rotation</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_bbox" class="method"><a class="src rightside" href="../src/plotpy/text.rs.html#138-141">Source</a><h4 class="code-header">pub fn <a href="#method.set_bbox" class="fn">set_bbox</a>(&mut self, flag: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a>) -> &mut Self</h4></section></summary><div class="docblock"><p>Sets use bounding box flag</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_bbox_facecolor" class="method"><a class="src rightside" href="../src/plotpy/text.rs.html#144-147">Source</a><h4 class="code-header">pub fn <a href="#method.set_bbox_facecolor" class="fn">set_bbox_facecolor</a>(&mut self, color: &<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.str.html">str</a>) -> &mut Self</h4></section></summary><div class="docblock"><p>Sets facecolor of bounding box</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_bbox_edgecolor" class="method"><a class="src rightside" href="../src/plotpy/text.rs.html#150-153">Source</a><h4 class="code-header">pub fn <a href="#method.set_bbox_edgecolor" class="fn">set_bbox_edgecolor</a>(&mut self, color: &<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.str.html">str</a>) -> &mut Self</h4></section></summary><div class="docblock"><p>Sets edgecolor of bounding box</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_bbox_alpha" class="method"><a class="src rightside" href="../src/plotpy/text.rs.html#156-159">Source</a><h4 class="code-header">pub fn <a href="#method.set_bbox_alpha" class="fn">set_bbox_alpha</a>(&mut self, value: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f64.html">f64</a>) -> &mut Self</h4></section></summary><div class="docblock"><p>Sets alpha of bounding box</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_bbox_style" class="method"><a class="src rightside" href="../src/plotpy/text.rs.html#176-179">Source</a><h4 class="code-header">pub fn <a href="#method.set_bbox_style" class="fn">set_bbox_style</a>(&mut self, style: &<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.str.html">str</a>) -> &mut Self</h4></section></summary><div class="docblock"><p>Sets style of bounding box; example</p>
|
|
<p>Examples:</p>
|
|
<ul>
|
|
<li>“square,pad=0.3”</li>
|
|
<li>“circle,pad=0.3”</li>
|
|
<li>“larrow,pad=0.3”</li>
|
|
<li>“rarrow,pad=0.3”</li>
|
|
<li>“darrow,pad=0.3”</li>
|
|
<li>“round,pad=0.3,rounding_size=0.15”</li>
|
|
<li>“round4,pad=0.3,rounding_size=0.2”</li>
|
|
<li>“sawtooth,pad=0.3,tooth_size=0.1”</li>
|
|
<li>“roundtooth,pad=0.3,tooth_size=0.2”</li>
|
|
</ul>
|
|
<p>See <a href="https://matplotlib.org/stable/api/_as_gen/matplotlib.patches.BoxStyle.html">Matplotlib</a></p>
|
|
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-GraphMaker-for-Text" class="impl"><a class="src rightside" href="../src/plotpy/text.rs.html#219-226">Source</a><a href="#impl-GraphMaker-for-Text" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.GraphMaker.html" title="trait plotpy::GraphMaker">GraphMaker</a> for <a class="struct" href="struct.Text.html" title="struct plotpy::Text">Text</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.get_buffer" class="method trait-impl"><a class="src rightside" href="../src/plotpy/text.rs.html#220-222">Source</a><a href="#method.get_buffer" class="anchor">§</a><h4 class="code-header">fn <a href="trait.GraphMaker.html#tymethod.get_buffer" class="fn">get_buffer</a><'a>(&'a self) -> &'a <a class="struct" href="https://doc.rust-lang.org/1.84.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section></summary><div class='docblock'>Returns the text buffer with Python3 commands</div></details><details class="toggle method-toggle" open><summary><section id="method.clear_buffer" class="method trait-impl"><a class="src rightside" href="../src/plotpy/text.rs.html#223-225">Source</a><a href="#method.clear_buffer" class="anchor">§</a><h4 class="code-header">fn <a href="trait.GraphMaker.html#tymethod.clear_buffer" class="fn">clear_buffer</a>(&mut self)</h4></section></summary><div class='docblock'>Clear the text buffer with Python commands</div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-Text" class="impl"><a href="#impl-Freeze-for-Text" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.Text.html" title="struct plotpy::Text">Text</a></h3></section><section id="impl-RefUnwindSafe-for-Text" class="impl"><a href="#impl-RefUnwindSafe-for-Text" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Text.html" title="struct plotpy::Text">Text</a></h3></section><section id="impl-Send-for-Text" class="impl"><a href="#impl-Send-for-Text" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Text.html" title="struct plotpy::Text">Text</a></h3></section><section id="impl-Sync-for-Text" class="impl"><a href="#impl-Sync-for-Text" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Text.html" title="struct plotpy::Text">Text</a></h3></section><section id="impl-Unpin-for-Text" class="impl"><a href="#impl-Unpin-for-Text" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Text.html" title="struct plotpy::Text">Text</a></h3></section><section id="impl-UnwindSafe-for-Text" class="impl"><a href="#impl-UnwindSafe-for-Text" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Text.html" title="struct plotpy::Text">Text</a></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/any.rs.html#138">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
|
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#209">Source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#211">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#217">Source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#218">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#765">Source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#768">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#748-750">Source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#758">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html#tymethod.into" class="fn">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.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#805-807">Source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#809">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#812">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/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.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#790-792">Source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#794">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#797">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/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.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html> |