mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-27 04:19:33 +01:00
57 lines
32 KiB
HTML
57 lines
32 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="Atomics-based shared bus `I2c` implementation."><title>AtomicDevice in embedded_hal_bus::i2c - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.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-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-b0742ba02757f159.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="embedded_hal_bus" data-themes="" data-resource-suffix="" data-rustdoc-version="1.83.0 (90b35a623 2024-11-26)" data-channel="1.83.0" data-search-js="search-f0d225181b97f9a4.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-f070b9041d14864c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-0111fcff984fae8f.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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="../../embedded_hal_bus/index.html">embedded_<wbr>hal_<wbr>bus</a><span class="version">0.2.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Atomic<wbr>Device</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.new" title="new">new</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-ErrorType-for-AtomicDevice%3C'a,+T%3E" title="ErrorType">ErrorType</a></li><li><a href="#impl-I2c-for-AtomicDevice%3C'a,+T%3E" title="I2c">I2c</a></li><li><a href="#impl-Send-for-AtomicDevice%3C'a,+T%3E" title="Send">Send</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-RefUnwindSafe-for-AtomicDevice%3C'a,+T%3E" title="!RefUnwindSafe">!RefUnwindSafe</a></li><li><a href="#impl-UnwindSafe-for-AtomicDevice%3C'a,+T%3E" title="!UnwindSafe">!UnwindSafe</a></li><li><a href="#impl-Freeze-for-AtomicDevice%3C'a,+T%3E" title="Freeze">Freeze</a></li><li><a href="#impl-Sync-for-AtomicDevice%3C'a,+T%3E" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-AtomicDevice%3C'a,+T%3E" 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&#
|
|||
|
|
<p>Sharing is implemented with a <a href="struct.AtomicDevice.html" title="struct embedded_hal_bus::i2c::AtomicDevice"><code>AtomicDevice</code></a>, which consists of an <code>UnsafeCell</code> and an <code>AtomicBool</code> “locked” flag.
|
|||
|
|
This means it has low overhead, like <a href="struct.RefCellDevice.html" title="struct embedded_hal_bus::i2c::RefCellDevice"><code>RefCellDevice</code></a>. Aditionally, it is <code>Send</code>,
|
|||
|
|
which allows sharing a single bus across multiple threads (interrupt priority level), like <a href="struct.CriticalSectionDevice.html" title="struct embedded_hal_bus::i2c::CriticalSectionDevice"><code>CriticalSectionDevice</code></a>,
|
|||
|
|
while not using critical sections and therefore impacting real-time performance less.</p>
|
|||
|
|
<p>The downside is using a simple <code>AtomicBool</code> for locking doesn’t prevent two threads from trying to lock it at once.
|
|||
|
|
For example, the main thread can be doing an I2C transaction, and an interrupt fires and tries to do another. In this
|
|||
|
|
case, a <code>Busy</code> error is returned that must be handled somehow, usually dropping the data or trying again later.</p>
|
|||
|
|
<p>Note that retrying in a loop on <code>Busy</code> errors usually leads to deadlocks. In the above example, it’ll prevent the
|
|||
|
|
interrupt handler from returning, which will starve the main thread and prevent it from releasing the lock. If
|
|||
|
|
this is an issue for your use case, you most likely should use <a href="struct.CriticalSectionDevice.html" title="struct embedded_hal_bus::i2c::CriticalSectionDevice"><code>CriticalSectionDevice</code></a> instead.</p>
|
|||
|
|
<p>This primitive is particularly well-suited for applications that have external arbitration
|
|||
|
|
rules that prevent <code>Busy</code> errors in the first place, such as the RTIC framework.</p>
|
|||
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
|||
|
|
<p>Assuming there is a pressure sensor with address <code>0x42</code> on the same bus as a temperature sensor
|
|||
|
|
with address <code>0x20</code>; <a href="struct.AtomicDevice.html" title="struct embedded_hal_bus::i2c::AtomicDevice"><code>AtomicDevice</code></a> can be used to give access to both of these sensors
|
|||
|
|
from a single <code>i2c</code> instance.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>embedded_hal_bus::i2c;
|
|||
|
|
<span class="kw">use </span>embedded_hal_bus::util::AtomicCell;
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>i2c = hal.i2c();
|
|||
|
|
<span class="kw">let </span>i2c_cell = AtomicCell::new(i2c);
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>temperature_sensor = TemperatureSensor::new(
|
|||
|
|
i2c::AtomicDevice::new(<span class="kw-2">&</span>i2c_cell),
|
|||
|
|
<span class="number">0x20</span>,
|
|||
|
|
);
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>pressure_sensor = PressureSensor::new(
|
|||
|
|
i2c::AtomicDevice::new(<span class="kw-2">&</span>i2c_cell),
|
|||
|
|
<span class="number">0x42</span>,
|
|||
|
|
);</code></pre></div>
|
|||
|
|
</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-AtomicDevice%3C'a,+T%3E" class="impl"><a class="src rightside" href="../../src/embedded_hal_bus/i2c/atomic.rs.html#106-138">source</a><a href="#impl-AtomicDevice%3C'a,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'a, T> <a class="struct" href="struct.AtomicDevice.html" title="struct embedded_hal_bus::i2c::AtomicDevice">AtomicDevice</a><'a, T><div class="where">where
|
|||
|
|
T: <a class="trait" href="../../embedded_hal/i2c/trait.I2c.html" title="trait embedded_hal::i2c::I2c">I2c</a>,</div></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/embedded_hal_bus/i2c/atomic.rs.html#112-114">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>(bus: &'a <a class="struct" href="../util/struct.AtomicCell.html" title="struct embedded_hal_bus::util::AtomicCell">AtomicCell</a><T>) -> Self</h4></section></summary><div class="docblock"><p>Create a new <code>AtomicDevice</code>.</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-ErrorType-for-AtomicDevice%3C'a,+T%3E" class="impl"><a class="src rightside" href="../../src/embedded_hal_bus/i2c/atomic.rs.html#140-145">source</a><a href="#impl-ErrorType-for-AtomicDevice%3C'a,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'a, T> <a class="trait" href="../../embedded_hal/i2c/trait.ErrorType.html" title="trait embedded_hal::i2c::ErrorType">ErrorType</a> for <a class="struct" href="struct.AtomicDevice.html" title="struct embedded_hal_bus::i2c::AtomicDevice">AtomicDevice</a><'a, T><div class="where">where
|
|||
|
|
T: <a class="trait" href="../../embedded_hal/i2c/trait.I2c.html" title="trait embedded_hal::i2c::I2c">I2c</a>,</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="../../src/embedded_hal_bus/i2c/atomic.rs.html#144">source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="../../embedded_hal/i2c/trait.ErrorType.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="enum.AtomicError.html" title="enum embedded_hal_bus::i2c::AtomicError">AtomicError</a><<T as <a class="trait" href="../../embedded_hal/i2c/trait.ErrorType.html" title="trait embedded_hal::i2c::ErrorType">ErrorType</a>>::<a class="associatedtype" href="../../embedded_hal/i2c/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::i2c::ErrorType::Error">Error</a>></h4></section></summary><div class='docblock'>Error type</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-I2c-for-AtomicDevice%3C'a,+T%3E" class="impl"><a class="src rightside" href="../../src/embedded_hal_bus/i2c/atomic.rs.html#147-179">source</a><a href="#impl-I2c-for-AtomicDevice%3C'a,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'a, T> <a class="trait" href="../../embedded_hal/i2c/trait.I2c.html" title="trait embedded_hal::i2c::I2c">I2c</a> for <a class="struct" href="struct.AtomicDevice.html" title="struct embedded_hal_bus::i2c::AtomicDevice">AtomicDevice</a><'a, T><div class="where">where
|
|||
|
|
T: <a class="trait" href="../../embedded_hal/i2c/trait.I2c.html" title="trait embedded_hal::i2c::I2c">I2c</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.read" class="method trait-impl"><a class="src rightside" href="../../src/embedded_hal_bus/i2c/atomic.rs.html#152-154">source</a><a href="#method.read" class="anchor">§</a><h4 class="code-header">fn <a href="../../embedded_hal/i2c/trait.I2c.html#method.read" class="fn">read</a>(&mut self, address: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u8.html">u8</a>, read: &mut [<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u8.html">u8</a>]) -> <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../embedded_hal/i2c/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::i2c::ErrorType::Error">Error</a>></h4></section></summary><div class='docblock'>Reads enough bytes from slave with <code>address</code> to fill <code>read</code>. <a href="../../embedded_hal/i2c/trait.I2c.html#method.read">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write" class="method trait-impl"><a class="src rightside" href="../../src/embedded_hal_bus/i2c/atomic.rs.html#157-159">source</a><a href="#method.write" class="anchor">§</a><h4 class="code-header">fn <a href="../../embedded_hal/i2c/trait.I2c.html#method.write" class="fn">write</a>(&mut self, address: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u8.html">u8</a>, write: &[<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u8.html">u8</a>]) -> <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../embedded_hal/i2c/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::i2c::ErrorType::Error">Error</a>></h4></section></summary><div class='docblock'>Writes bytes to slave with address <code>address</code>. <a href="../../embedded_hal/i2c/trait.I2c.html#method.write">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_read" class="method trait-impl"><a class="src rightside" href="../../src/embedded_hal_bus/i2c/atomic.rs.html#162-169">source</a><a href="#method.write_read" class="anchor">§</a><h4 class="code-header">fn <a href="../../embedded_hal/i2c/trait.I2c.html#method.write_read" class="fn">write_read</a>(
|
|||
|
|
&mut self,
|
|||
|
|
address: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u8.html">u8</a>,
|
|||
|
|
write: &[<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u8.html">u8</a>],
|
|||
|
|
read: &mut [<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u8.html">u8</a>],
|
|||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../embedded_hal/i2c/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::i2c::ErrorType::Error">Error</a>></h4></section></summary><div class='docblock'>Writes bytes to slave with address <code>address</code> and then reads enough bytes to fill <code>read</code> <em>in a
|
|||
|
|
single transaction</em>. <a href="../../embedded_hal/i2c/trait.I2c.html#method.write_read">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.transaction" class="method trait-impl"><a class="src rightside" href="../../src/embedded_hal_bus/i2c/atomic.rs.html#172-178">source</a><a href="#method.transaction" class="anchor">§</a><h4 class="code-header">fn <a href="../../embedded_hal/i2c/trait.I2c.html#tymethod.transaction" class="fn">transaction</a>(
|
|||
|
|
&mut self,
|
|||
|
|
address: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u8.html">u8</a>,
|
|||
|
|
operations: &mut [<a class="enum" href="../../embedded_hal/i2c/enum.Operation.html" title="enum embedded_hal::i2c::Operation">Operation</a><'_>],
|
|||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../embedded_hal/i2c/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::i2c::ErrorType::Error">Error</a>></h4></section></summary><div class='docblock'>Execute the provided operations on the I2C bus. <a href="../../embedded_hal/i2c/trait.I2c.html#tymethod.transaction">Read more</a></div></details></div></details><section id="impl-Send-for-AtomicDevice%3C'a,+T%3E" class="impl"><a class="src rightside" href="../../src/embedded_hal_bus/i2c/atomic.rs.html#104">source</a><a href="#impl-Send-for-AtomicDevice%3C'a,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'a, T> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.AtomicDevice.html" title="struct embedded_hal_bus::i2c::AtomicDevice">AtomicDevice</a><'a, T></h3></section></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-AtomicDevice%3C'a,+T%3E" class="impl"><a href="#impl-Freeze-for-AtomicDevice%3C'a,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'a, T> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.AtomicDevice.html" title="struct embedded_hal_bus::i2c::AtomicDevice">AtomicDevice</a><'a, T></h3></section><section id="impl-RefUnwindSafe-for-AtomicDevice%3C'a,+T%3E" class="impl"><a href="#impl-RefUnwindSafe-for-AtomicDevice%3C'a,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'a, T> !<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.AtomicDevice.html" title="struct embedded_hal_bus::i2c::AtomicDevice">AtomicDevice</a><'a, T></h3></section><section id="impl-Sync-for-AtomicDevice%3C'a,+T%3E" class="impl"><a href="#impl-Sync-for-AtomicDevice%3C'a,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'a, T> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.AtomicDevice.html" title="struct embedded_hal_bus::i2c::AtomicDevice">AtomicDevice</a><'a, T><div class="where">where
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-Unpin-for-AtomicDevice%3C'a,+T%3E" class="impl"><a href="#impl-Unpin-for-AtomicDevice%3C'a,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'a, T> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.AtomicDevice.html" title="struct embedded_hal_bus::i2c::AtomicDevice">AtomicDevice</a><'a, T></h3></section><section id="impl-UnwindSafe-for-AtomicDevice%3C'a,+T%3E" class="impl"><a href="#impl-UnwindSafe-for-AtomicDevice%3C'a,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'a, T> !<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.AtomicDevice.html" title="struct embedded_hal_bus::i2c::AtomicDevice">AtomicDevice</a><'a, T></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.83.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.83.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.83.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.83.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.83.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.83.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.83.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.83.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.83.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.83.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.83.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.83.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/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.83.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.83.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.83.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.83.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.83.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.83.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.83.0/core/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.83.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.83.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.83.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.83.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.83.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.83.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.83.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.83.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.83.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.83.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.83.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.83.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.83.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.83.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-2" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#809">source</a><a href="#associatedtype.Error-2" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.83.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.83.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.83.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.83.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.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.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.83.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.83.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.83.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-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#794">source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.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.83.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.83.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.83.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.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.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>
|