mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
168 lines
54 KiB
HTML
168 lines
54 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="This represents a single TLS client connection."><title>ClientConnection in rustls::client - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustls" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><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">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustls/index.html">rustls</a><span class="version">0.21.7</span></h2></div><h2 class="location"><a href="#">ClientConnection</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.early_data">early_data</a></li><li><a href="#method.is_early_data_accepted">is_early_data_accepted</a></li><li><a href="#method.new">new</a></li></ul><h3><a href="#deref-methods-ConnectionCommon%3CClientConnectionData%3E">Methods from Deref<Target=ConnectionCommon<ClientConnectionData>></a></h3><ul class="block deref-methods"><li><a href="#method.complete_io">complete_io</a></li><li><a href="#method.export_keying_material">export_keying_material</a></li><li><a href="#method.process_new_packets">process_new_packets</a></li><li><a href="#method.read_tls">read_tls</a></li><li><a href="#method.reader">reader</a></li><li><a href="#method.write_tls">write_tls</a></li><li><a href="#method.writer">writer</a></li></ul><h3><a href="#deref-methods-CommonState">Methods from Deref<Target=CommonState></a></h3><ul class="block deref-methods"><li><a href="#method.alpn_protocol">alpn_protocol</a></li><li><a href="#method.is_handshaking">is_handshaking</a></li><li><a href="#method.negotiated_cipher_suite">negotiated_cipher_suite</a></li><li><a href="#method.peer_certificates">peer_certificates</a></li><li><a href="#method.protocol_version">protocol_version</a></li><li><a href="#method.send_close_notify">send_close_notify</a></li><li><a href="#method.set_buffer_limit">set_buffer_limit</a></li><li><a href="#method.wants_read">wants_read</a></li><li><a href="#method.wants_write">wants_write</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-ClientConnection">Debug</a></li><li><a href="#impl-Deref-for-ClientConnection">Deref</a></li><li><a href="#impl-DerefMut-for-ClientConnection">DerefMut</a></li><li><a href="#impl-From%3CClientConnection%3E-for-Connection">From<ClientConnection></a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-RefUnwindSafe-for-ClientConnection">!RefUnwindSafe</a></li><li><a href="#impl-UnwindSafe-for-ClientConnection">!UnwindSafe</a></li><li><a href="#impl-Send-for-ClientConnection">Send</a></li><li><a href="#impl-Sync-for-ClientConnection">Sync</a></li><li><a href="#impl-Unpin-for-ClientConnection">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">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-T">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-T">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T">TryInto<U></a></li></ul></section><h2><a href="index.html">In rustls::client</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../rustls/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Struct <a href="../index.html">rustls</a>::<wbr><a href="index.html">client</a>::<wbr><a class="struct" href="#">ClientConnection</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/rustls/client/client_conn.rs.html#533-535">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub struct ClientConnection { <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>This represents a single TLS client connection.</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-ClientConnection" class="impl"><a class="src rightside" href="../../src/rustls/client/client_conn.rs.html#544-613">source</a><a href="#impl-ClientConnection" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.ClientConnection.html" title="struct rustls::client::ClientConnection">ClientConnection</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../../src/rustls/client/client_conn.rs.html#548-552">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>(config: <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="struct.ClientConfig.html" title="struct rustls::client::ClientConfig">ClientConfig</a>>, name: <a class="enum" href="enum.ServerName.html" title="enum rustls::client::ServerName">ServerName</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="enum" href="../enum.Error.html" title="enum rustls::Error">Error</a>></h4></section></summary><div class="docblock"><p>Make a new ClientConnection. <code>config</code> controls how
|
||
we behave in the TLS protocol, <code>name</code> is the
|
||
name of the server we want to talk to.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.early_data" class="method"><a class="src rightside" href="../../src/rustls/client/client_conn.rs.html#572-584">source</a><h4 class="code-header">pub fn <a href="#method.early_data" class="fn">early_data</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.WriteEarlyData.html" title="struct rustls::client::WriteEarlyData">WriteEarlyData</a><'_>></h4></section></summary><div class="docblock"><p>Returns an <code>io::Write</code> implementer you can write bytes to
|
||
to send TLS1.3 early data (a.k.a. “0-RTT data”) to the server.</p>
|
||
<p>This returns None in many circumstances when the capability to
|
||
send early data is not available, including but not limited to:</p>
|
||
<ul>
|
||
<li>The server hasn’t been talked to previously.</li>
|
||
<li>The server does not support resumption.</li>
|
||
<li>The server does not support early data.</li>
|
||
<li>The resumption data for the server has expired.</li>
|
||
</ul>
|
||
<p>The server specifies a maximum amount of early data. You can
|
||
learn this limit through the returned object, and writes through
|
||
it will process only this many bytes.</p>
|
||
<p>The server can choose not to accept any sent early data –
|
||
in this case the data is lost but the connection continues. You
|
||
can tell this happened using <code>is_early_data_accepted</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_early_data_accepted" class="method"><a class="src rightside" href="../../src/rustls/client/client_conn.rs.html#591-593">source</a><h4 class="code-header">pub fn <a href="#method.is_early_data_accepted" class="fn">is_early_data_accepted</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns True if the server signalled it will process early data.</p>
|
||
<p>If you sent early data and this returns false at the end of the
|
||
handshake then the server will not process the data. This
|
||
is not an error, but you may wish to resend the data.</p>
|
||
</div></details></div></details></div><h2 id="deref-methods-ConnectionCommon%3CClientConnectionData%3E" class="section-header"><span>Methods from <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a><Target = <a class="struct" href="../struct.ConnectionCommon.html" title="struct rustls::ConnectionCommon">ConnectionCommon</a><<a class="struct" href="struct.ClientConnectionData.html" title="struct rustls::client::ClientConnectionData">ClientConnectionData</a>>></span><a href="#deref-methods-ConnectionCommon%3CClientConnectionData%3E" class="anchor">§</a></h2><div id="deref-methods-ConnectionCommon%3CClientConnectionData%3E-1" class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.reader" class="method"><a class="src rightside" href="../../src/rustls/conn.rs.html#323-333">source</a><h4 class="code-header">pub fn <a href="#method.reader" class="fn">reader</a>(&mut self) -> <a class="struct" href="../struct.Reader.html" title="struct rustls::Reader">Reader</a><'_> <a href="#" class="tooltip" data-notable-ty="Reader<'_>">ⓘ</a></h4></section></summary><div class="docblock"><p>Returns an object that allows reading plaintext.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.writer" class="method"><a class="src rightside" href="../../src/rustls/conn.rs.html#336-338">source</a><h4 class="code-header">pub fn <a href="#method.writer" class="fn">writer</a>(&mut self) -> <a class="struct" href="../struct.Writer.html" title="struct rustls::Writer">Writer</a><'_> <a href="#" class="tooltip" data-notable-ty="Writer<'_>">ⓘ</a></h4></section></summary><div class="docblock"><p>Returns an object that allows writing plaintext.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.complete_io" class="method"><a class="src rightside" href="../../src/rustls/conn.rs.html#369-433">source</a><h4 class="code-header">pub fn <a href="#method.complete_io" class="fn">complete_io</a><T>(&mut self, io: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&mut T</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a>), <a class="struct" href="https://doc.rust-lang.org/1.76.0/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/std/io/trait.Write.html" title="trait std::io::Write">Write</a>,</div></h4></section></summary><div class="docblock"><p>This function uses <code>io</code> to complete any outstanding IO for
|
||
this connection.</p>
|
||
<p>This is a convenience function which solely uses other parts
|
||
of the public API.</p>
|
||
<p>What this means depends on the connection state:</p>
|
||
<ul>
|
||
<li>If the connection <a href="../struct.CommonState.html#method.is_handshaking" title="method rustls::CommonState::is_handshaking"><code>is_handshaking</code></a>, then IO is performed until
|
||
the handshake is complete.</li>
|
||
<li>Otherwise, if <a href="../struct.CommonState.html#method.wants_write" title="method rustls::CommonState::wants_write"><code>wants_write</code></a> is true, <a href="../struct.ConnectionCommon.html#method.write_tls" title="method rustls::ConnectionCommon::write_tls"><code>write_tls</code></a> is invoked
|
||
until it is all written.</li>
|
||
<li>Otherwise, if <a href="../struct.CommonState.html#method.wants_read" title="method rustls::CommonState::wants_read"><code>wants_read</code></a> is true, <a href="../struct.ConnectionCommon.html#method.read_tls" title="method rustls::ConnectionCommon::read_tls"><code>read_tls</code></a> is invoked
|
||
once.</li>
|
||
</ul>
|
||
<p>The return value is the number of bytes read from and written
|
||
to <code>io</code>, respectively.</p>
|
||
<p>This function will block if <code>io</code> blocks.</p>
|
||
<p>Errors from TLS record handling (i.e., from <a href="../struct.ConnectionCommon.html#method.process_new_packets" title="method rustls::ConnectionCommon::process_new_packets"><code>process_new_packets</code></a>)
|
||
are wrapped in an <code>io::ErrorKind::InvalidData</code>-kind error.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.process_new_packets" class="method"><a class="src rightside" href="../../src/rustls/conn.rs.html#474-476">source</a><h4 class="code-header">pub fn <a href="#method.process_new_packets" class="fn">process_new_packets</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../struct.IoState.html" title="struct rustls::IoState">IoState</a>, <a class="enum" href="../enum.Error.html" title="enum rustls::Error">Error</a>></h4></section></summary><div class="docblock"><p>Processes any new packets read by a previous call to
|
||
<a href="../enum.Connection.html#method.read_tls" title="method rustls::Connection::read_tls"><code>Connection::read_tls</code></a>.</p>
|
||
<p>Errors from this function relate to TLS protocol errors, and
|
||
are fatal to the connection. Future calls after an error will do
|
||
no new work and will return the same error. After an error is
|
||
received from <a href="../enum.Connection.html#method.process_new_packets" title="method rustls::Connection::process_new_packets"><code>process_new_packets</code></a>, you should not call <a href="../enum.Connection.html#method.read_tls" title="method rustls::Connection::read_tls"><code>read_tls</code></a>
|
||
any more (it will fill up buffers to no purpose). However, you
|
||
may call the other methods on the connection, including <code>write</code>,
|
||
<code>send_close_notify</code>, and <code>write_tls</code>. Most likely you will want to
|
||
call <code>write_tls</code> to send any alerts queued by the error and then
|
||
close the underlying connection.</p>
|
||
<p>Success from this function comes with some sundry state data
|
||
about the connection.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.read_tls" class="method"><a class="src rightside" href="../../src/rustls/conn.rs.html#497-510">source</a><h4 class="code-header">pub fn <a href="#method.read_tls" class="fn">read_tls</a>(&mut self, rd: &mut dyn <a class="trait" href="https://doc.rust-lang.org/1.76.0/std/io/trait.Read.html" title="trait std::io::Read">Read</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a>, <a class="struct" href="https://doc.rust-lang.org/1.76.0/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>></h4></section></summary><div class="docblock"><p>Read TLS content from <code>rd</code> into the internal buffer.</p>
|
||
<p>Due to the internal buffering, <code>rd</code> can supply TLS messages in arbitrary-sized chunks (like
|
||
a socket or pipe might).</p>
|
||
<p>You should call <a href="../struct.ConnectionCommon.html#method.process_new_packets" title="method rustls::ConnectionCommon::process_new_packets"><code>process_new_packets()</code></a> each time a call to this function succeeds in order
|
||
to empty the incoming TLS data buffer.</p>
|
||
<p>This function returns <code>Ok(0)</code> when the underlying <code>rd</code> does so. This typically happens when
|
||
a socket is cleanly closed, or a file is at EOF. Errors may result from the IO done through
|
||
<code>rd</code>; additionally, errors of <code>ErrorKind::Other</code> are emitted to signal backpressure:</p>
|
||
<ul>
|
||
<li>In order to empty the incoming TLS data buffer, you should call <a href="../struct.ConnectionCommon.html#method.process_new_packets" title="method rustls::ConnectionCommon::process_new_packets"><code>process_new_packets()</code></a>
|
||
each time a call to this function succeeds.</li>
|
||
<li>In order to empty the incoming plaintext data buffer, you should empty it through
|
||
the <a href="../struct.ConnectionCommon.html#method.reader" title="method rustls::ConnectionCommon::reader"><code>reader()</code></a> after the call to <a href="../struct.ConnectionCommon.html#method.process_new_packets" title="method rustls::ConnectionCommon::process_new_packets"><code>process_new_packets()</code></a>.</li>
|
||
</ul>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.write_tls" class="method"><a class="src rightside" href="../../src/rustls/conn.rs.html#519-521">source</a><h4 class="code-header">pub fn <a href="#method.write_tls" class="fn">write_tls</a>(&mut self, wr: &mut dyn <a class="trait" href="https://doc.rust-lang.org/1.76.0/std/io/trait.Write.html" title="trait std::io::Write">Write</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a>, <a class="struct" href="https://doc.rust-lang.org/1.76.0/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>></h4></section></summary><div class="docblock"><p>Writes TLS messages to <code>wr</code>.</p>
|
||
<p>On success, this function returns <code>Ok(n)</code> where <code>n</code> is a number of bytes written to <code>wr</code>
|
||
(after encoding and encryption).</p>
|
||
<p>After this function returns, the connection buffer may not yet be fully flushed. The
|
||
<a href="../struct.CommonState.html#method.wants_write" title="method rustls::CommonState::wants_write"><code>CommonState::wants_write</code></a> function can be used to check if the output buffer is empty.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.export_keying_material" class="method"><a class="src rightside" href="../../src/rustls/conn.rs.html#539-547">source</a><h4 class="code-header">pub fn <a href="#method.export_keying_material" class="fn">export_keying_material</a><T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.AsMut.html" title="trait core::convert::AsMut">AsMut</a><[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>]>>(
|
||
&self,
|
||
output: T,
|
||
label: &[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>],
|
||
context: <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>]>
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <a class="enum" href="../enum.Error.html" title="enum rustls::Error">Error</a>></h4></section></summary><div class="docblock"><p>Derives key material from the agreed connection secrets.</p>
|
||
<p>This function fills in <code>output</code> with <code>output.len()</code> bytes of key
|
||
material derived from the master session secret using <code>label</code>
|
||
and <code>context</code> for diversification. Ownership of the buffer is taken
|
||
by the function and returned via the Ok result to ensure no key
|
||
material leaks if the function fails.</p>
|
||
<p>See RFC5705 for more details on what this does and is for.</p>
|
||
<p>For TLS1.3 connections, this function does not use the
|
||
“early” exporter at any point.</p>
|
||
<p>This function fails if called prior to the handshake completing;
|
||
check with <a href="../struct.CommonState.html#method.is_handshaking" title="method rustls::CommonState::is_handshaking"><code>CommonState::is_handshaking</code></a> first.</p>
|
||
</div></details></div><h2 id="deref-methods-CommonState" class="section-header"><span>Methods from <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a><Target = <a class="struct" href="../struct.CommonState.html" title="struct rustls::CommonState">CommonState</a>></span><a href="#deref-methods-CommonState" class="anchor">§</a></h2><div id="deref-methods-CommonState-1" class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.wants_write" class="method"><a class="src rightside" href="../../src/rustls/common_state.rs.html#89-91">source</a><h4 class="code-header">pub fn <a href="#method.wants_write" class="fn">wants_write</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns true if the caller should call <a href="../enum.Connection.html#method.write_tls" title="method rustls::Connection::write_tls"><code>Connection::write_tls</code></a> as soon as possible.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_handshaking" class="method"><a class="src rightside" href="../../src/rustls/common_state.rs.html#100-102">source</a><h4 class="code-header">pub fn <a href="#method.is_handshaking" class="fn">is_handshaking</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns true if the connection is currently performing the TLS handshake.</p>
|
||
<p>During this time plaintext written to the connection is buffered in memory. After
|
||
<a href="../enum.Connection.html#method.process_new_packets" title="method rustls::Connection::process_new_packets"><code>Connection::process_new_packets()</code></a> has been called, this might start to return <code>false</code>
|
||
while the final handshake packets still need to be extracted from the connection’s buffers.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.peer_certificates" class="method"><a class="src rightside" href="../../src/rustls/common_state.rs.html#119-121">source</a><h4 class="code-header">pub fn <a href="#method.peer_certificates" class="fn">peer_certificates</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&[<a class="struct" href="../struct.Certificate.html" title="struct rustls::Certificate">Certificate</a>]></h4></section></summary><div class="docblock"><p>Retrieves the certificate chain used by the peer to authenticate.</p>
|
||
<p>The order of the certificate chain is as it appears in the TLS
|
||
protocol: the first certificate relates to the peer, the
|
||
second certifies the first, the third certifies the second, and
|
||
so on.</p>
|
||
<p>This is made available for both full and resumed handshakes.</p>
|
||
<p>For clients, this is the certificate chain of the server.</p>
|
||
<p>For servers, this is the certificate chain of the client,
|
||
if client authentication was completed.</p>
|
||
<p>The return value is None until this value is available.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.alpn_protocol" class="method"><a class="src rightside" href="../../src/rustls/common_state.rs.html#128-130">source</a><h4 class="code-header">pub fn <a href="#method.alpn_protocol" class="fn">alpn_protocol</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>]></h4></section></summary><div class="docblock"><p>Retrieves the protocol agreed with the peer via ALPN.</p>
|
||
<p>A return value of <code>None</code> after handshake completion
|
||
means no protocol was agreed (because no protocols
|
||
were offered or accepted by the peer).</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.negotiated_cipher_suite" class="method"><a class="src rightside" href="../../src/rustls/common_state.rs.html#135-137">source</a><h4 class="code-header">pub fn <a href="#method.negotiated_cipher_suite" class="fn">negotiated_cipher_suite</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../enum.SupportedCipherSuite.html" title="enum rustls::SupportedCipherSuite">SupportedCipherSuite</a>></h4></section></summary><div class="docblock"><p>Retrieves the ciphersuite agreed with the peer.</p>
|
||
<p>This returns None until the ciphersuite is agreed.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.protocol_version" class="method"><a class="src rightside" href="../../src/rustls/common_state.rs.html#142-144">source</a><h4 class="code-header">pub fn <a href="#method.protocol_version" class="fn">protocol_version</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../enum.ProtocolVersion.html" title="enum rustls::ProtocolVersion">ProtocolVersion</a>></h4></section></summary><div class="docblock"><p>Retrieves the protocol version agreed with the peer.</p>
|
||
<p>This returns <code>None</code> until the version is agreed.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_buffer_limit" class="method"><a class="src rightside" href="../../src/rustls/common_state.rs.html#359-362">source</a><h4 class="code-header">pub fn <a href="#method.set_buffer_limit" class="fn">set_buffer_limit</a>(&mut self, limit: <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a>>)</h4></section></summary><div class="docblock"><p>Sets a limit on the internal buffers used to buffer
|
||
unsent plaintext (prior to completing the TLS handshake)
|
||
and unsent TLS records. This limit acts only on application
|
||
data written through <a href="../enum.Connection.html#method.writer" title="method rustls::Connection::writer"><code>Connection::writer</code></a>.</p>
|
||
<p>By default the limit is 64KB. The limit can be set
|
||
at any time, even if the current buffer use is higher.</p>
|
||
<p><a href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html#variant.None" title="variant core::option::Option::None"><code>None</code></a> means no limit applies, and will mean that written
|
||
data is buffered without bound – it is up to the application
|
||
to appropriately schedule its plaintext and TLS writes to bound
|
||
memory usage.</p>
|
||
<p>For illustration: <code>Some(1)</code> means a limit of one byte applies:
|
||
<a href="../enum.Connection.html#method.writer" title="method rustls::Connection::writer"><code>Connection::writer</code></a> will accept only one byte, encrypt it and
|
||
add a TLS header. Once this is sent via <a href="../enum.Connection.html#method.write_tls" title="method rustls::Connection::write_tls"><code>Connection::write_tls</code></a>,
|
||
another byte may be sent.</p>
|
||
<h5 id="internal-write-direction-buffering"><a href="#internal-write-direction-buffering">Internal write-direction buffering</a></h5>
|
||
<p>rustls has two buffers whose size are bounded by this setting:</p>
|
||
<h6 id="buffering-of-unsent-plaintext-data-prior-to-handshake-completion"><a href="#buffering-of-unsent-plaintext-data-prior-to-handshake-completion">Buffering of unsent plaintext data prior to handshake completion</a></h6>
|
||
<p>Calls to <a href="../enum.Connection.html#method.writer" title="method rustls::Connection::writer"><code>Connection::writer</code></a> before or during the handshake
|
||
are buffered (up to the limit specified here). Once the
|
||
handshake completes this data is encrypted and the resulting
|
||
TLS records are added to the outgoing buffer.</p>
|
||
<h6 id="buffering-of-outgoing-tls-records"><a href="#buffering-of-outgoing-tls-records">Buffering of outgoing TLS records</a></h6>
|
||
<p>This buffer is used to store TLS records that rustls needs to
|
||
send to the peer. It is used in these two circumstances:</p>
|
||
<ul>
|
||
<li>by <a href="../enum.Connection.html#method.process_new_packets" title="method rustls::Connection::process_new_packets"><code>Connection::process_new_packets</code></a> when a handshake or alert
|
||
TLS record needs to be sent.</li>
|
||
<li>by <a href="../enum.Connection.html#method.writer" title="method rustls::Connection::writer"><code>Connection::writer</code></a> post-handshake: the plaintext is
|
||
encrypted and the resulting TLS record is buffered.</li>
|
||
</ul>
|
||
<p>This buffer is emptied by <a href="../enum.Connection.html#method.write_tls" title="method rustls::Connection::write_tls"><code>Connection::write_tls</code></a>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.send_close_notify" class="method"><a class="src rightside" href="../../src/rustls/common_state.rs.html#497-500">source</a><h4 class="code-header">pub fn <a href="#method.send_close_notify" class="fn">send_close_notify</a>(&mut self)</h4></section></summary><div class="docblock"><p>Queues a close_notify warning alert to be sent in the next
|
||
<a href="../enum.Connection.html#method.write_tls" title="method rustls::Connection::write_tls"><code>Connection::write_tls</code></a> call. This informs the peer that the
|
||
connection is being closed.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.wants_read" class="method"><a class="src rightside" href="../../src/rustls/common_state.rs.html#527-537">source</a><h4 class="code-header">pub fn <a href="#method.wants_read" class="fn">wants_read</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns true if the caller should call <a href="../enum.Connection.html#method.read_tls" title="method rustls::Connection::read_tls"><code>Connection::read_tls</code></a> as soon
|
||
as possible.</p>
|
||
<p>If there is pending plaintext data to read with <a href="../enum.Connection.html#method.reader" title="method rustls::Connection::reader"><code>Connection::reader</code></a>,
|
||
this returns false. If your application respects this mechanism,
|
||
only one full TLS message will be buffered by rustls.</p>
|
||
</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-ClientConnection" class="impl"><a class="src rightside" href="../../src/rustls/client/client_conn.rs.html#537-542">source</a><a href="#impl-Debug-for-ClientConnection" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.ClientConnection.html" title="struct rustls::client::ClientConnection">ClientConnection</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/rustls/client/client_conn.rs.html#538-541">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.76.0/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.76.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Deref-for-ClientConnection" class="impl"><a class="src rightside" href="../../src/rustls/client/client_conn.rs.html#615-621">source</a><a href="#impl-Deref-for-ClientConnection" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a> for <a class="struct" href="struct.ClientConnection.html" title="struct rustls::client::ClientConnection">ClientConnection</a></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Target" class="associatedtype trait-impl"><a href="#associatedtype.Target" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.76.0/core/ops/deref/trait.Deref.html#associatedtype.Target" class="associatedtype">Target</a> = <a class="struct" href="../struct.ConnectionCommon.html" title="struct rustls::ConnectionCommon">ConnectionCommon</a><<a class="struct" href="struct.ClientConnectionData.html" title="struct rustls::client::ClientConnectionData">ClientConnectionData</a>></h4></section></summary><div class='docblock'>The resulting type after dereferencing.</div></details><details class="toggle method-toggle" open><summary><section id="method.deref" class="method trait-impl"><a class="src rightside" href="../../src/rustls/client/client_conn.rs.html#618-620">source</a><a href="#method.deref" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/ops/deref/trait.Deref.html#tymethod.deref" class="fn">deref</a>(&self) -> &Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a></h4></section></summary><div class='docblock'>Dereferences the value.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-DerefMut-for-ClientConnection" class="impl"><a class="src rightside" href="../../src/rustls/client/client_conn.rs.html#623-627">source</a><a href="#impl-DerefMut-for-ClientConnection" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/deref/trait.DerefMut.html" title="trait core::ops::deref::DerefMut">DerefMut</a> for <a class="struct" href="struct.ClientConnection.html" title="struct rustls::client::ClientConnection">ClientConnection</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.deref_mut" class="method trait-impl"><a class="src rightside" href="../../src/rustls/client/client_conn.rs.html#624-626">source</a><a href="#method.deref_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/ops/deref/trait.DerefMut.html#tymethod.deref_mut" class="fn">deref_mut</a>(&mut self) -> &mut Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a></h4></section></summary><div class='docblock'>Mutably dereferences the value.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3CClientConnection%3E-for-Connection" class="impl"><a class="src rightside" href="../../src/rustls/client/client_conn.rs.html#642-646">source</a><a href="#impl-From%3CClientConnection%3E-for-Connection" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="struct.ClientConnection.html" title="struct rustls::client::ClientConnection">ClientConnection</a>> for <a class="enum" href="../enum.Connection.html" title="enum rustls::Connection">Connection</a></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="../../src/rustls/client/client_conn.rs.html#643-645">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(conn: <a class="struct" href="struct.ClientConnection.html" title="struct rustls::client::ClientConnection">ClientConnection</a>) -> Self</h4></section></summary><div class='docblock'>Converts to this type from the input type.</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-RefUnwindSafe-for-ClientConnection" class="impl"><a href="#impl-RefUnwindSafe-for-ClientConnection" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.ClientConnection.html" title="struct rustls::client::ClientConnection">ClientConnection</a></h3></section><section id="impl-Send-for-ClientConnection" class="impl"><a href="#impl-Send-for-ClientConnection" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.ClientConnection.html" title="struct rustls::client::ClientConnection">ClientConnection</a></h3></section><section id="impl-Sync-for-ClientConnection" class="impl"><a href="#impl-Sync-for-ClientConnection" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.ClientConnection.html" title="struct rustls::client::ClientConnection">ClientConnection</a></h3></section><section id="impl-Unpin-for-ClientConnection" class="impl"><a href="#impl-Unpin-for-ClientConnection" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.ClientConnection.html" title="struct rustls::client::ClientConnection">ClientConnection</a></h3></section><section id="impl-UnwindSafe-for-ClientConnection" class="impl"><a href="#impl-UnwindSafe-for-ClientConnection" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.ClientConnection.html" title="struct rustls::client::ClientConnection">ClientConnection</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.76.0/src/core/any.rs.html#140">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.76.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.76.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.76.0/src/core/any.rs.html#141">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.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.76.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.76.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.76.0/src/core/borrow.rs.html#208">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.76.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.76.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.76.0/src/core/borrow.rs.html#210">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.76.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.76.0/src/core/borrow.rs.html#216">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.76.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.76.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.76.0/src/core/borrow.rs.html#217">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.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.76.0/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.76.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.76.0/src/core/convert/mod.rs.html#763">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.76.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-1" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#766">source</a><a href="#method.from-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.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.76.0/src/core/convert/mod.rs.html#747-749">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.76.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.76.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.76.0/src/core/convert/mod.rs.html#756">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.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.76.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.76.0/src/core/convert/mod.rs.html#803-805">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.76.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.76.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.76.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.76.0/src/core/convert/mod.rs.html#810">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.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.76.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.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.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.76.0/src/core/convert/mod.rs.html#788-790">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.76.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.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.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.76.0/src/core/convert/mod.rs.html#795">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.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.76.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.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.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><script type="text/json" id="notable-traits-data">{"Reader<'_>":"<h3>Notable traits for <code><a class=\"struct\" href=\"../struct.Reader.html\" title=\"struct rustls::Reader\">Reader</a><'a></code></h3><pre><code><div class=\"where\">impl<'a> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.76.0/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a> for <a class=\"struct\" href=\"../struct.Reader.html\" title=\"struct rustls::Reader\">Reader</a><'a></div>","Writer<'_>":"<h3>Notable traits for <code><a class=\"struct\" href=\"../struct.Writer.html\" title=\"struct rustls::Writer\">Writer</a><'a></code></h3><pre><code><div class=\"where\">impl<'a> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.76.0/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> for <a class=\"struct\" href=\"../struct.Writer.html\" title=\"struct rustls::Writer\">Writer</a><'a></div>"}</script></section></div></main></body></html> |