66 lines
30 KiB
HTML
66 lines
30 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="An AEAD key for authenticating and decrypting (“opening”), bound to a nonce sequence."><title>OpeningKey in ring::aead - 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="ring" 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="#">OpeningKey</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../ring/index.html">ring</a><span class="version">0.17.14</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Opening<wbr>Key</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.open_in_place" title="open_in_place">open_in_place</a></li><li><a href="#method.open_within" title="open_within">open_within</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-BoundKey%3CN%3E-for-OpeningKey%3CN%3E" title="BoundKey<N>">BoundKey<N></a></li><li><a href="#impl-Debug-for-OpeningKey%3CN%3E" 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-Freeze-for-OpeningKey%3CN%3E" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-OpeningKey%3CN%3E" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-OpeningKey%3CN%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-OpeningKey%3CN%3E" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-OpeningKey%3CN%3E" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-OpeningKey%3CN%3E" 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><a href="index.html">In ring::<wbr>aead</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">ring</a>::<wbr><a href="index.html">aead</a></div><h1>Struct <span class="struct">Opening<wbr>Key</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/ring/aead/opening_key.rs.html#33-36">Source</a> </span></div><pre class="rust item-decl"><code>pub struct OpeningKey<N: <a class="trait" href="trait.NonceSequence.html" title="trait ring::aead::NonceSequence">NonceSequence</a>> { <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>An AEAD key for authenticating and decrypting (“opening”), bound to a nonce
|
||
sequence.</p>
|
||
<p>Intentionally not <code>Clone</code> or <code>Copy</code> since cloning would allow duplication
|
||
of the nonce sequence.</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-OpeningKey%3CN%3E" class="impl"><a class="src rightside" href="../../src/ring/aead/opening_key.rs.html#58-143">Source</a><a href="#impl-OpeningKey%3CN%3E" class="anchor">§</a><h3 class="code-header">impl<N: <a class="trait" href="trait.NonceSequence.html" title="trait ring::aead::NonceSequence">NonceSequence</a>> <a class="struct" href="struct.OpeningKey.html" title="struct ring::aead::OpeningKey">OpeningKey</a><N></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.open_in_place" class="method"><a class="src rightside" href="../../src/ring/aead/opening_key.rs.html#71-81">Source</a><h4 class="code-header">pub fn <a href="#method.open_in_place" class="fn">open_in_place</a><'in_out, A>(
|
||
&mut self,
|
||
aad: <a class="struct" href="struct.Aad.html" title="struct ring::aead::Aad">Aad</a><A>,
|
||
in_out: &'in_out mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>],
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&'in_out mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>], <a class="struct" href="../error/struct.Unspecified.html" title="struct ring::error::Unspecified">Unspecified</a>><div class="where">where
|
||
A: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]>,</div></h4></section></summary><div class="docblock"><p>Authenticates and decrypts (“opens”) data in place.</p>
|
||
<p><code>aad</code> is the additional authenticated data (AAD), if any.</p>
|
||
<p>On input, <code>in_out</code> must be the ciphertext followed by the tag. When
|
||
<code>open_in_place()</code> returns <code>Ok(plaintext)</code>, the input ciphertext
|
||
has been overwritten by the plaintext; <code>plaintext</code> will refer to the
|
||
plaintext without the tag.</p>
|
||
<p>When <code>open_in_place()</code> returns <code>Err(..)</code>, <code>in_out</code> may have been
|
||
overwritten in an unspecified way.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.open_within" class="method"><a class="src rightside" href="../../src/ring/aead/opening_key.rs.html#127-142">Source</a><h4 class="code-header">pub fn <a href="#method.open_within" class="fn">open_within</a><'in_out, A>(
|
||
&mut self,
|
||
aad: <a class="struct" href="struct.Aad.html" title="struct ring::aead::Aad">Aad</a><A>,
|
||
in_out: &'in_out mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>],
|
||
ciphertext_and_tag: <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/ops/range/struct.RangeFrom.html" title="struct core::ops::range::RangeFrom">RangeFrom</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>>,
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&'in_out mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>], <a class="struct" href="../error/struct.Unspecified.html" title="struct ring::error::Unspecified">Unspecified</a>><div class="where">where
|
||
A: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]>,</div></h4></section></summary><div class="docblock"><p>Authenticates and decrypts (“opens”) data in place, with a shift.</p>
|
||
<p><code>aad</code> is the additional authenticated data (AAD), if any.</p>
|
||
<p>On input, <code>in_out[ciphertext_and_tag]</code> must be the ciphertext followed
|
||
by the tag. When <code>open_within()</code> returns <code>Ok(plaintext)</code>, the plaintext
|
||
will be at <code>in_out[0..plaintext.len()]</code>. In other words, the following
|
||
two code fragments are equivalent for valid values of
|
||
<code>ciphertext_and_tag</code>, except <code>open_within</code> will often be more efficient:</p>
|
||
<div class="example-wrap"><pre class="language-skip"><code>let plaintext = key.open_within(aad, in_out, cipertext_and_tag)?;</code></pre></div><div class="example-wrap"><pre class="language-skip"><code>let ciphertext_and_tag_len = in_out[ciphertext_and_tag].len();
|
||
in_out.copy_within(ciphertext_and_tag, 0);
|
||
let plaintext = key.open_in_place(aad, &mut in_out[..ciphertext_and_tag_len])?;</code></pre></div>
|
||
<p>Similarly, <code>key.open_within(aad, in_out, 0..)</code> is equivalent to
|
||
<code>key.open_in_place(aad, in_out)</code>.</p>
|
||
<p>When <code>open_in_place()</code> returns <code>Err(..)</code>, <code>in_out</code> may have been
|
||
overwritten in an unspecified way.</p>
|
||
<p>The shifting feature is useful in the case where multiple packets are
|
||
being reassembled in place. Consider this example where the peer has
|
||
sent the message “Split stream reassembled in place” split into
|
||
three sealed packets:</p>
|
||
<div class="example-wrap"><pre class="language-ascii-art"><code> Packet 1 Packet 2 Packet 3
|
||
Input: [Header][Ciphertext][Tag][Header][Ciphertext][Tag][Header][Ciphertext][Tag]
|
||
| +--------------+ |
|
||
+------+ +-----+ +----------------------------------+
|
||
v v v
|
||
Output: [Plaintext][Plaintext][Plaintext]
|
||
“Split stream reassembled in place”</code></pre></div>
|
||
<p>This reassembly can be accomplished with three calls to <code>open_within()</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-BoundKey%3CN%3E-for-OpeningKey%3CN%3E" class="impl"><a class="src rightside" href="../../src/ring/aead/opening_key.rs.html#38-50">Source</a><a href="#impl-BoundKey%3CN%3E-for-OpeningKey%3CN%3E" class="anchor">§</a><h3 class="code-header">impl<N: <a class="trait" href="trait.NonceSequence.html" title="trait ring::aead::NonceSequence">NonceSequence</a>> <a class="trait" href="trait.BoundKey.html" title="trait ring::aead::BoundKey">BoundKey</a><N> for <a class="struct" href="struct.OpeningKey.html" title="struct ring::aead::OpeningKey">OpeningKey</a><N></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method trait-impl"><a class="src rightside" href="../../src/ring/aead/opening_key.rs.html#39-44">Source</a><a href="#method.new" class="anchor">§</a><h4 class="code-header">fn <a href="trait.BoundKey.html#tymethod.new" class="fn">new</a>(key: <a class="struct" href="struct.UnboundKey.html" title="struct ring::aead::UnboundKey">UnboundKey</a>, nonce_sequence: N) -> Self</h4></section></summary><div class='docblock'>Constructs a new key from the given <code>UnboundKey</code> and <code>NonceSequence</code>.</div></details><details class="toggle method-toggle" open><summary><section id="method.algorithm" class="method trait-impl"><a class="src rightside" href="../../src/ring/aead/opening_key.rs.html#47-49">Source</a><a href="#method.algorithm" class="anchor">§</a><h4 class="code-header">fn <a href="trait.BoundKey.html#tymethod.algorithm" class="fn">algorithm</a>(&self) -> &'static <a class="struct" href="struct.Algorithm.html" title="struct ring::aead::Algorithm">Algorithm</a></h4></section></summary><div class='docblock'>The key’s AEAD algorithm.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-OpeningKey%3CN%3E" class="impl"><a class="src rightside" href="../../src/ring/aead/opening_key.rs.html#52-56">Source</a><a href="#impl-Debug-for-OpeningKey%3CN%3E" class="anchor">§</a><h3 class="code-header">impl<N: <a class="trait" href="trait.NonceSequence.html" title="trait ring::aead::NonceSequence">NonceSequence</a>> <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.OpeningKey.html" title="struct ring::aead::OpeningKey">OpeningKey</a><N></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/ring/aead/opening_key.rs.html#53-55">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="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</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-OpeningKey%3CN%3E" class="impl"><a href="#impl-Freeze-for-OpeningKey%3CN%3E" class="anchor">§</a><h3 class="code-header">impl<N> <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.OpeningKey.html" title="struct ring::aead::OpeningKey">OpeningKey</a><N><div class="where">where
|
||
N: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a>,</div></h3></section><section id="impl-RefUnwindSafe-for-OpeningKey%3CN%3E" class="impl"><a href="#impl-RefUnwindSafe-for-OpeningKey%3CN%3E" class="anchor">§</a><h3 class="code-header">impl<N> <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.OpeningKey.html" title="struct ring::aead::OpeningKey">OpeningKey</a><N><div class="where">where
|
||
N: <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>,</div></h3></section><section id="impl-Send-for-OpeningKey%3CN%3E" class="impl"><a href="#impl-Send-for-OpeningKey%3CN%3E" class="anchor">§</a><h3 class="code-header">impl<N> <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.OpeningKey.html" title="struct ring::aead::OpeningKey">OpeningKey</a><N><div class="where">where
|
||
N: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-Sync-for-OpeningKey%3CN%3E" class="impl"><a href="#impl-Sync-for-OpeningKey%3CN%3E" class="anchor">§</a><h3 class="code-header">impl<N> <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.OpeningKey.html" title="struct ring::aead::OpeningKey">OpeningKey</a><N><div class="where">where
|
||
N: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,</div></h3></section><section id="impl-Unpin-for-OpeningKey%3CN%3E" class="impl"><a href="#impl-Unpin-for-OpeningKey%3CN%3E" class="anchor">§</a><h3 class="code-header">impl<N> <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.OpeningKey.html" title="struct ring::aead::OpeningKey">OpeningKey</a><N><div class="where">where
|
||
N: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h3></section><section id="impl-UnwindSafe-for-OpeningKey%3CN%3E" class="impl"><a href="#impl-UnwindSafe-for-OpeningKey%3CN%3E" class="anchor">§</a><h3 class="code-header">impl<N> <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.OpeningKey.html" title="struct ring::aead::OpeningKey">OpeningKey</a><N><div class="where">where
|
||
N: <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>,</div></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> |