124 lines
34 KiB
HTML
124 lines
34 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="Interval returned by `interval` and `interval_at`."><title>Interval in tokio::time - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.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"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="tokio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.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]--><rustdoc-topbar><h2><a href="#">Interval</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../tokio/index.html">tokio</a><span class="version">1.49.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Interval</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.missed_tick_behavior" title="missed_tick_behavior">missed_tick_behavior</a></li><li><a href="#method.period" title="period">period</a></li><li><a href="#method.poll_tick" title="poll_tick">poll_tick</a></li><li><a href="#method.reset" title="reset">reset</a></li><li><a href="#method.reset_after" title="reset_after">reset_after</a></li><li><a href="#method.reset_at" title="reset_at">reset_at</a></li><li><a href="#method.reset_immediately" title="reset_immediately">reset_immediately</a></li><li><a href="#method.set_missed_tick_behavior" title="set_missed_tick_behavior">set_missed_tick_behavior</a></li><li><a href="#method.tick" title="tick">tick</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-Interval" title="Debug">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-RefUnwindSafe-for-Interval" title="!RefUnwindSafe">!RefUnwindSafe</a></li><li><a href="#impl-UnwindSafe-for-Interval" title="!UnwindSafe">!UnwindSafe</a></li><li><a href="#impl-Freeze-for-Interval" title="Freeze">Freeze</a></li><li><a href="#impl-Send-for-Interval" title="Send">Send</a></li><li><a href="#impl-Sync-for-Interval" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-Interval" title="Unpin">Unpin</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><a href="index.html">In tokio::<wbr>time</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">tokio</a>::<wbr><a href="index.html">time</a></div><h1>Struct <span class="struct">Interval</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/tokio/time/interval.rs.html#392-404">Source</a> </span></div><pre class="rust item-decl"><code>pub struct Interval { <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>Interval returned by <a href="fn.interval.html" title="fn tokio::time::interval"><code>interval</code></a> and <a href="fn.interval_at.html" title="fn tokio::time::interval_at"><code>interval_at</code></a>.</p>
|
|
<p>This type allows you to wait on a sequence of instants with a certain
|
|
duration between each instant. Unlike calling <a href="fn.sleep.html" title="fn tokio::time::sleep"><code>sleep</code></a> in a loop, this lets
|
|
you count the time spent between the calls to <a href="fn.sleep.html" title="fn tokio::time::sleep"><code>sleep</code></a> as well.</p>
|
|
<p>An <code>Interval</code> can be turned into a <code>Stream</code> with <a href="https://docs.rs/tokio-stream/latest/tokio_stream/wrappers/struct.IntervalStream.html"><code>IntervalStream</code></a>.</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-Interval" class="impl"><a class="src rightside" href="../../src/tokio/time/interval.rs.html#406-643">Source</a><a href="#impl-Interval" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.Interval.html" title="struct tokio::time::Interval">Interval</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.tick" class="method"><a class="src rightside" href="../../src/tokio/time/interval.rs.html#433-448">Source</a><h4 class="code-header">pub async fn <a href="#method.tick" class="fn">tick</a>(&mut self) -> <a class="struct" href="struct.Instant.html" title="struct tokio::time::Instant">Instant</a></h4></section></summary><div class="docblock"><p>Completes when the next instant in the interval has been reached.</p>
|
|
<h5 id="cancel-safety"><a class="doc-anchor" href="#cancel-safety">§</a>Cancel safety</h5>
|
|
<p>This method is cancellation safe. If <code>tick</code> is used as the branch in a <code>tokio::select!</code> and
|
|
another branch completes first, then no tick has been consumed.</p>
|
|
<h5 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::time;
|
|
|
|
<span class="kw">use </span>std::time::Duration;
|
|
|
|
<span class="kw">let </span><span class="kw-2">mut </span>interval = time::interval(Duration::from_millis(<span class="number">10</span>));
|
|
|
|
interval.tick().<span class="kw">await</span>;
|
|
<span class="comment">// approximately 0ms have elapsed. The first tick completes immediately.
|
|
</span>interval.tick().<span class="kw">await</span>;
|
|
interval.tick().<span class="kw">await</span>;
|
|
|
|
<span class="comment">// approximately 20ms have elapsed.</span></code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.poll_tick" class="method"><a class="src rightside" href="../../src/tokio/time/interval.rs.html#462-494">Source</a><h4 class="code-header">pub fn <a href="#method.poll_tick" class="fn">poll_tick</a>(&mut self, cx: &mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="struct" href="struct.Instant.html" title="struct tokio::time::Instant">Instant</a>></h4></section></summary><div class="docblock"><p>Polls for the next instant in the interval to be reached.</p>
|
|
<p>This method can return the following values:</p>
|
|
<ul>
|
|
<li><code>Poll::Pending</code> if the next instant has not yet been reached.</li>
|
|
<li><code>Poll::Ready(instant)</code> if the next instant has been reached.</li>
|
|
</ul>
|
|
<p>When this method returns <code>Poll::Pending</code>, the current task is scheduled
|
|
to receive a wakeup when the instant has elapsed. Note that on multiple
|
|
calls to <code>poll_tick</code>, only the <a href="https://doc.rust-lang.org/1.93.1/core/task/wake/struct.Waker.html" title="struct core::task::wake::Waker"><code>Waker</code></a> from the
|
|
<a href="https://doc.rust-lang.org/1.93.1/core/task/wake/struct.Context.html" title="struct core::task::wake::Context"><code>Context</code></a> passed to the most recent call is scheduled to receive a
|
|
wakeup.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.reset" class="method"><a class="src rightside" href="../../src/tokio/time/interval.rs.html#524-526">Source</a><h4 class="code-header">pub fn <a href="#method.reset" class="fn">reset</a>(&mut self)</h4></section></summary><div class="docblock"><p>Resets the interval to complete one period after the current time.</p>
|
|
<p>This method ignores <a href="enum.MissedTickBehavior.html" title="enum tokio::time::MissedTickBehavior"><code>MissedTickBehavior</code></a> strategy.</p>
|
|
<p>This is equivalent to calling <code>reset_at(Instant::now() + period)</code>.</p>
|
|
<h5 id="examples-1"><a class="doc-anchor" href="#examples-1">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::time;
|
|
|
|
<span class="kw">use </span>std::time::Duration;
|
|
|
|
<span class="kw">let </span><span class="kw-2">mut </span>interval = time::interval(Duration::from_millis(<span class="number">100</span>));
|
|
|
|
interval.tick().<span class="kw">await</span>;
|
|
|
|
time::sleep(Duration::from_millis(<span class="number">50</span>)).<span class="kw">await</span>;
|
|
interval.reset();
|
|
|
|
interval.tick().<span class="kw">await</span>;
|
|
interval.tick().<span class="kw">await</span>;
|
|
|
|
<span class="comment">// approximately 250ms have elapsed.</span></code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.reset_immediately" class="method"><a class="src rightside" href="../../src/tokio/time/interval.rs.html#556-558">Source</a><h4 class="code-header">pub fn <a href="#method.reset_immediately" class="fn">reset_immediately</a>(&mut self)</h4></section></summary><div class="docblock"><p>Resets the interval immediately.</p>
|
|
<p>This method ignores <a href="enum.MissedTickBehavior.html" title="enum tokio::time::MissedTickBehavior"><code>MissedTickBehavior</code></a> strategy.</p>
|
|
<p>This is equivalent to calling <code>reset_at(Instant::now())</code>.</p>
|
|
<h5 id="examples-2"><a class="doc-anchor" href="#examples-2">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::time;
|
|
|
|
<span class="kw">use </span>std::time::Duration;
|
|
|
|
<span class="kw">let </span><span class="kw-2">mut </span>interval = time::interval(Duration::from_millis(<span class="number">100</span>));
|
|
|
|
interval.tick().<span class="kw">await</span>;
|
|
|
|
time::sleep(Duration::from_millis(<span class="number">50</span>)).<span class="kw">await</span>;
|
|
interval.reset_immediately();
|
|
|
|
interval.tick().<span class="kw">await</span>;
|
|
interval.tick().<span class="kw">await</span>;
|
|
|
|
<span class="comment">// approximately 150ms have elapsed.</span></code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.reset_after" class="method"><a class="src rightside" href="../../src/tokio/time/interval.rs.html#589-591">Source</a><h4 class="code-header">pub fn <a href="#method.reset_after" class="fn">reset_after</a>(&mut self, after: <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>)</h4></section></summary><div class="docblock"><p>Resets the interval after the specified <a href="https://doc.rust-lang.org/1.93.1/core/time/struct.Duration.html" title="struct core::time::Duration"><code>std::time::Duration</code></a>.</p>
|
|
<p>This method ignores <a href="enum.MissedTickBehavior.html" title="enum tokio::time::MissedTickBehavior"><code>MissedTickBehavior</code></a> strategy.</p>
|
|
<p>This is equivalent to calling <code>reset_at(Instant::now() + after)</code>.</p>
|
|
<h5 id="examples-3"><a class="doc-anchor" href="#examples-3">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::time;
|
|
|
|
<span class="kw">use </span>std::time::Duration;
|
|
|
|
<span class="kw">let </span><span class="kw-2">mut </span>interval = time::interval(Duration::from_millis(<span class="number">100</span>));
|
|
interval.tick().<span class="kw">await</span>;
|
|
|
|
time::sleep(Duration::from_millis(<span class="number">50</span>)).<span class="kw">await</span>;
|
|
|
|
<span class="kw">let </span>after = Duration::from_millis(<span class="number">20</span>);
|
|
interval.reset_after(after);
|
|
|
|
interval.tick().<span class="kw">await</span>;
|
|
interval.tick().<span class="kw">await</span>;
|
|
|
|
<span class="comment">// approximately 170ms have elapsed.</span></code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.reset_at" class="method"><a class="src rightside" href="../../src/tokio/time/interval.rs.html#625-627">Source</a><h4 class="code-header">pub fn <a href="#method.reset_at" class="fn">reset_at</a>(&mut self, deadline: <a class="struct" href="struct.Instant.html" title="struct tokio::time::Instant">Instant</a>)</h4></section></summary><div class="docblock"><p>Resets the interval to a <a href="struct.Instant.html" title="struct tokio::time::Instant"><code>crate::time::Instant</code></a> deadline.</p>
|
|
<p>Sets the next tick to expire at the given instant. If the instant is in
|
|
the past, then the <a href="enum.MissedTickBehavior.html" title="enum tokio::time::MissedTickBehavior"><code>MissedTickBehavior</code></a> strategy will be used to
|
|
catch up. If the instant is in the future, then the next tick will
|
|
complete at the given instant, even if that means that it will sleep for
|
|
longer than the duration of this <a href="struct.Interval.html" title="struct tokio::time::Interval"><code>Interval</code></a>. If the <a href="struct.Interval.html" title="struct tokio::time::Interval"><code>Interval</code></a> had
|
|
any missed ticks before calling this method, then those are discarded.</p>
|
|
<h5 id="examples-4"><a class="doc-anchor" href="#examples-4">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::time::{<span class="self">self</span>, Instant};
|
|
|
|
<span class="kw">use </span>std::time::Duration;
|
|
|
|
<span class="kw">let </span><span class="kw-2">mut </span>interval = time::interval(Duration::from_millis(<span class="number">100</span>));
|
|
interval.tick().<span class="kw">await</span>;
|
|
|
|
time::sleep(Duration::from_millis(<span class="number">50</span>)).<span class="kw">await</span>;
|
|
|
|
<span class="kw">let </span>deadline = Instant::now() + Duration::from_millis(<span class="number">30</span>);
|
|
interval.reset_at(deadline);
|
|
|
|
interval.tick().<span class="kw">await</span>;
|
|
interval.tick().<span class="kw">await</span>;
|
|
|
|
<span class="comment">// approximately 180ms have elapsed.</span></code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.missed_tick_behavior" class="method"><a class="src rightside" href="../../src/tokio/time/interval.rs.html#630-632">Source</a><h4 class="code-header">pub fn <a href="#method.missed_tick_behavior" class="fn">missed_tick_behavior</a>(&self) -> <a class="enum" href="enum.MissedTickBehavior.html" title="enum tokio::time::MissedTickBehavior">MissedTickBehavior</a></h4></section></summary><div class="docblock"><p>Returns the <a href="enum.MissedTickBehavior.html" title="enum tokio::time::MissedTickBehavior"><code>MissedTickBehavior</code></a> strategy currently being used.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_missed_tick_behavior" class="method"><a class="src rightside" href="../../src/tokio/time/interval.rs.html#635-637">Source</a><h4 class="code-header">pub fn <a href="#method.set_missed_tick_behavior" class="fn">set_missed_tick_behavior</a>(&mut self, behavior: <a class="enum" href="enum.MissedTickBehavior.html" title="enum tokio::time::MissedTickBehavior">MissedTickBehavior</a>)</h4></section></summary><div class="docblock"><p>Sets the <a href="enum.MissedTickBehavior.html" title="enum tokio::time::MissedTickBehavior"><code>MissedTickBehavior</code></a> strategy that should be used.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.period" class="method"><a class="src rightside" href="../../src/tokio/time/interval.rs.html#640-642">Source</a><h4 class="code-header">pub fn <a href="#method.period" class="fn">period</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a></h4></section></summary><div class="docblock"><p>Returns the period of the interval.</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-Debug-for-Interval" class="impl"><a class="src rightside" href="../../src/tokio/time/interval.rs.html#391">Source</a><a href="#impl-Debug-for-Interval" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Interval.html" title="struct tokio::time::Interval">Interval</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../../src/tokio/time/interval.rs.html#391">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></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-Interval" class="impl"><a href="#impl-Freeze-for-Interval" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.Interval.html" title="struct tokio::time::Interval">Interval</a></h3></section><section id="impl-RefUnwindSafe-for-Interval" class="impl"><a href="#impl-RefUnwindSafe-for-Interval" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Interval.html" title="struct tokio::time::Interval">Interval</a></h3></section><section id="impl-Send-for-Interval" class="impl"><a href="#impl-Send-for-Interval" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Interval.html" title="struct tokio::time::Interval">Interval</a></h3></section><section id="impl-Sync-for-Interval" class="impl"><a href="#impl-Sync-for-Interval" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Interval.html" title="struct tokio::time::Interval">Interval</a></h3></section><section id="impl-Unpin-for-Interval" class="impl"><a href="#impl-Unpin-for-Interval" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Interval.html" title="struct tokio::time::Interval">Interval</a></h3></section><section id="impl-UnwindSafe-for-Interval" class="impl"><a href="#impl-UnwindSafe-for-Interval" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Interval.html" title="struct tokio::time::Interval">Interval</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.93.1/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.93.1/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.93.1/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.93.1/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.93.1/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.93.1/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.93.1/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.93.1/src/core/borrow.rs.html#212">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.93.1/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.93.1/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.93.1/src/core/borrow.rs.html#214">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/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.93.1/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.93.1/src/core/borrow.rs.html#221">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.93.1/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.93.1/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.93.1/src/core/borrow.rs.html#222">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/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.93.1/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.93.1/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.93.1/src/core/convert/mod.rs.html#785">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.93.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="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#788">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/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.93.1/src/core/convert/mod.rs.html#767-769">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.93.1/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.93.1/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.93.1/src/core/convert/mod.rs.html#777">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/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.93.1/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.93.1/src/core/convert/mod.rs.html#827-829">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.93.1/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.93.1/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.93.1/src/core/convert/mod.rs.html#831">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.93.1/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.93.1/src/core/convert/mod.rs.html#834">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/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.93.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.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/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.93.1/src/core/convert/mod.rs.html#811-813">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.93.1/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.93.1/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.93.1/src/core/convert/mod.rs.html#815">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/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.93.1/src/core/convert/mod.rs.html#818">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.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.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/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> |