| <!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 session."><meta name="keywords" content="rust, rustlang, rust-lang, ClientSession"><title>ClientSession in rustls - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.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><a class="sidebar-logo" href="../rustls/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../rustls/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">ClientSession</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><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="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Debug-for-ClientSession">Debug</a></li><li><a href="#impl-Read-for-ClientSession">Read</a></li><li><a href="#impl-Session-for-ClientSession">Session</a></li><li><a href="#impl-Write-for-ClientSession">Write</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-ClientSession">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-ClientSession">Send</a></li><li><a href="#impl-Sync-for-ClientSession">Sync</a></li><li><a href="#impl-Unpin-for-ClientSession">Unpin</a></li><li><a href="#impl-UnwindSafe-for-ClientSession">!UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-ClientSession">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-ClientSession">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-ClientSession">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-ClientSession">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-ClientSession">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-ClientSession">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-ClientSession">TryInto<U></a></li></ul></section><h2><a href="index.html">In rustls</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="index.html">rustls</a>::<wbr><a class="struct" href="#">ClientSession</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/rustls/client/mod.rs.html#655-658">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct ClientSession { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This represents a single TLS client session.</p> |
| </div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-ClientSession" class="impl has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#660-704">source</a><a href="#impl-ClientSession" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.ClientSession.html" title="struct rustls::ClientSession">ClientSession</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#664-668">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>(config: &Arc<<a class="struct" href="struct.ClientConfig.html" title="struct rustls::ClientConfig">ClientConfig</a>>, hostname: <a class="struct" href="../webpki/name/struct.DNSNameRef.html" title="struct webpki::name::DNSNameRef">DNSNameRef</a><'_>) -> <a class="struct" href="struct.ClientSession.html" title="struct rustls::ClientSession">ClientSession</a></h4></section></summary><div class="docblock"><p>Make a new ClientSession. <code>config</code> controls how |
| we behave in the TLS protocol, <code>hostname</code> is the |
| hostname of who we want to talk to.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.early_data" class="method has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#688-694">source</a><h4 class="code-header">pub fn <a href="#method.early_data" class="fnname">early_data</a>(&mut self) -> Option<<a class="struct" href="struct.WriteEarlyData.html" title="struct rustls::WriteEarlyData">WriteEarlyData</a><'_>></h4></section></summary><div class="docblock"><p>Returns an <code>io::Write</code> implementor 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="rustdoc-toggle method-toggle" open><summary><section id="method.is_early_data_accepted" class="method has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#701-703">source</a><h4 class="code-header">pub fn <a href="#method.is_early_data_accepted" class="fnname">is_early_data_accepted</a>(&self) -> bool</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="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-ClientSession" class="impl has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#654">source</a><a href="#impl-Debug-for-ClientSession" class="anchor"></a><h3 class="code-header">impl Debug for <a class="struct" href="struct.ClientSession.html" title="struct rustls::ClientSession">ClientSession</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#654">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&self, f: &mut Formatter<'_>) -> Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Read-for-ClientSession" class="impl has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#769-785">source</a><a href="#impl-Read-for-ClientSession" class="anchor"></a><h3 class="code-header">impl Read for <a class="struct" href="struct.ClientSession.html" title="struct rustls::ClientSession">ClientSession</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#782-784">source</a><a href="#method.read" class="anchor"></a><h4 class="code-header">fn <a class="fnname">read</a>(&mut self, buf: &mut [u8]) -> Result<usize></h4></section></summary><div class="docblock"><p>Obtain plaintext data received from the peer over this TLS connection.</p> |
| <p>If the peer closes the TLS session cleanly, this fails with an error of |
| kind ErrorKind::ConnectionAborted once all the pending data has been read. |
| No further data can be received on that connection, so the underlying TCP |
| connection should closed too.</p> |
| <p>Note that support close notify varies in peer TLS libraries: many do not |
| support it and uncleanly close the TCP connection (this might be |
| vulnerable to truncation attacks depending on the application protocol). |
| This means applications using rustls must both handle ErrorKind::ConnectionAborted |
| from this function, <em>and</em> unexpected closure of the underlying TCP connection.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_vectored" class="method trait-impl has-srclink"><a href="#method.read_vectored" class="anchor"></a><h4 class="code-header">fn <a class="fnname">read_vectored</a>(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error></h4></section></summary><div class='docblock'>Like <code>read</code>, except that it reads into a slice of buffers. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_read_vectored" class="method trait-impl has-srclink"><a href="#method.is_read_vectored" class="anchor"></a><h4 class="code-header">fn <a class="fnname">is_read_vectored</a>(&self) -> bool</h4></section></summary><div class='docblock'>Determines if this <code>Read</code>er has an efficient <code>read_vectored</code> |
| implementation. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_to_end" class="method trait-impl has-srclink"><a href="#method.read_to_end" class="anchor"></a><h4 class="code-header">fn <a class="fnname">read_to_end</a>(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error></h4></section></summary><div class='docblock'>Read all bytes until EOF in this source, placing them into <code>buf</code>. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_to_string" class="method trait-impl has-srclink"><a href="#method.read_to_string" class="anchor"></a><h4 class="code-header">fn <a class="fnname">read_to_string</a>(&mut self, buf: &mut String) -> Result<usize, Error></h4></section></summary><div class='docblock'>Read all bytes until EOF in this source, appending them to <code>buf</code>. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_exact" class="method trait-impl has-srclink"><a href="#method.read_exact" class="anchor"></a><h4 class="code-header">fn <a class="fnname">read_exact</a>(&mut self, buf: &mut [u8]) -> Result<(), Error></h4></section></summary><div class='docblock'>Read the exact number of bytes required to fill <code>buf</code>. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_buf" class="method trait-impl has-srclink"><a href="#method.read_buf" class="anchor"></a><h4 class="code-header">fn <a class="fnname">read_buf</a>(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error></h4></section></summary><div class='docblock'>Pull some bytes from this source into the specified buffer. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_buf_exact" class="method trait-impl has-srclink"><a href="#method.read_buf_exact" class="anchor"></a><h4 class="code-header">fn <a class="fnname">read_buf_exact</a>(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error></h4></section></summary><div class='docblock'>Read the exact number of bytes required to fill <code>cursor</code>. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.by_ref" class="method trait-impl has-srclink"><a href="#method.by_ref" class="anchor"></a><h4 class="code-header">fn <a class="fnname">by_ref</a>(&mut self) -> &mut Self</h4></section></summary><div class='docblock'>Creates a “by reference” adaptor for this instance of <code>Read</code>. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.bytes" class="method trait-impl has-srclink"><a href="#method.bytes" class="anchor"></a><h4 class="code-header">fn <a class="fnname">bytes</a>(self) -> Bytes<Self></h4></section></summary><div class='docblock'>Transforms this <code>Read</code> instance to an [<code>Iterator</code>] over its bytes. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.chain" class="method trait-impl has-srclink"><a href="#method.chain" class="anchor"></a><h4 class="code-header">fn <a class="fnname">chain</a><R>(self, next: R) -> Chain<Self, R><span class="where fmt-newline">where<br> R: Read,</span></h4></section></summary><div class='docblock'>Creates an adapter which will chain this stream with another. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.take" class="method trait-impl has-srclink"><a href="#method.take" class="anchor"></a><h4 class="code-header">fn <a class="fnname">take</a>(self, limit: u64) -> Take<Self></h4></section></summary><div class='docblock'>Creates an adapter which will read at most <code>limit</code> bytes from it. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Session-for-ClientSession" class="impl has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#706-767">source</a><a href="#impl-Session-for-ClientSession" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Session.html" title="trait rustls::Session">Session</a> for <a class="struct" href="struct.ClientSession.html" title="struct rustls::ClientSession">ClientSession</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_tls" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#712-714">source</a><a href="#method.write_tls" class="anchor"></a><h4 class="code-header">fn <a href="trait.Session.html#tymethod.write_tls" class="fnname">write_tls</a>(&mut self, wr: &mut dyn Write) -> Result<usize></h4></section></summary><div class="docblock"><p>Writes TLS messages to <code>wr</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_tls" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#707-709">source</a><a href="#method.read_tls" class="anchor"></a><h4 class="code-header">fn <a href="trait.Session.html#tymethod.read_tls" class="fnname">read_tls</a>(&mut self, rd: &mut dyn Read) -> Result<usize></h4></section></summary><div class='docblock'>Read TLS content from <code>rd</code>. This method does internal |
| buffering, so <code>rd</code> can supply TLS messages in arbitrary- |
| sized chunks (like a socket or pipe might). <a href="trait.Session.html#tymethod.read_tls">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.process_new_packets" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#716-718">source</a><a href="#method.process_new_packets" class="anchor"></a><h4 class="code-header">fn <a href="trait.Session.html#tymethod.process_new_packets" class="fnname">process_new_packets</a>(&mut self) -> Result<(), <a class="enum" href="enum.TLSError.html" title="enum rustls::TLSError">TLSError</a>></h4></section></summary><div class='docblock'>Processes any new packets read by a previous call to <code>read_tls</code>. |
| Errors from this function relate to TLS protocol errors, and |
| are fatal to the session. Future calls after an error will do |
| no new work and will return the same error. <a href="trait.Session.html#tymethod.process_new_packets">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.wants_read" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#720-722">source</a><a href="#method.wants_read" class="anchor"></a><h4 class="code-header">fn <a href="trait.Session.html#tymethod.wants_read" class="fnname">wants_read</a>(&self) -> bool</h4></section></summary><div class='docblock'>Returns true if the caller should call <code>read_tls</code> as soon |
| as possible. <a href="trait.Session.html#tymethod.wants_read">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.wants_write" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#724-726">source</a><a href="#method.wants_write" class="anchor"></a><h4 class="code-header">fn <a href="trait.Session.html#tymethod.wants_write" class="fnname">wants_write</a>(&self) -> bool</h4></section></summary><div class='docblock'>Returns true if the caller should call <code>write_tls</code> as soon |
| as possible. <a href="trait.Session.html#tymethod.wants_write">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_handshaking" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#728-730">source</a><a href="#method.is_handshaking" class="anchor"></a><h4 class="code-header">fn <a href="trait.Session.html#tymethod.is_handshaking" class="fnname">is_handshaking</a>(&self) -> bool</h4></section></summary><div class='docblock'>Returns true if the session is currently perform the TLS |
| handshake. During this time plaintext written to the |
| session is buffered in memory. <a href="trait.Session.html#tymethod.is_handshaking">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.set_buffer_limit" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#732-734">source</a><a href="#method.set_buffer_limit" class="anchor"></a><h4 class="code-header">fn <a href="trait.Session.html#tymethod.set_buffer_limit" class="fnname">set_buffer_limit</a>(&mut self, len: usize)</h4></section></summary><div class='docblock'>Sets a limit on the internal buffers used to buffer |
| unsent plaintext (prior to completing the TLS handshake) |
| and unsent TLS records. <a href="trait.Session.html#tymethod.set_buffer_limit">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.send_close_notify" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#736-738">source</a><a href="#method.send_close_notify" class="anchor"></a><h4 class="code-header">fn <a href="trait.Session.html#tymethod.send_close_notify" class="fnname">send_close_notify</a>(&mut self)</h4></section></summary><div class='docblock'>Queues a close_notify fatal alert to be sent in the next |
| <code>write_tls</code> call. This informs the peer that the |
| connection is being closed. <a href="trait.Session.html#tymethod.send_close_notify">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_peer_certificates" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#740-742">source</a><a href="#method.get_peer_certificates" class="anchor"></a><h4 class="code-header">fn <a href="trait.Session.html#tymethod.get_peer_certificates" class="fnname">get_peer_certificates</a>(&self) -> Option<Vec<<a class="struct" href="struct.Certificate.html" title="struct rustls::Certificate">Certificate</a>>></h4></section></summary><div class='docblock'>Retrieves the certificate chain used by the peer to authenticate. <a href="trait.Session.html#tymethod.get_peer_certificates">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_alpn_protocol" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#744-746">source</a><a href="#method.get_alpn_protocol" class="anchor"></a><h4 class="code-header">fn <a href="trait.Session.html#tymethod.get_alpn_protocol" class="fnname">get_alpn_protocol</a>(&self) -> Option<&[u8]></h4></section></summary><div class='docblock'>Retrieves the protocol agreed with the peer via ALPN. <a href="trait.Session.html#tymethod.get_alpn_protocol">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_protocol_version" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#748-750">source</a><a href="#method.get_protocol_version" class="anchor"></a><h4 class="code-header">fn <a href="trait.Session.html#tymethod.get_protocol_version" class="fnname">get_protocol_version</a>(&self) -> Option<<a class="enum" href="internal/msgs/enums/enum.ProtocolVersion.html" title="enum rustls::internal::msgs::enums::ProtocolVersion">ProtocolVersion</a>></h4></section></summary><div class='docblock'>Retrieves the protocol version agreed with the peer. <a href="trait.Session.html#tymethod.get_protocol_version">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.export_keying_material" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#752-760">source</a><a href="#method.export_keying_material" class="anchor"></a><h4 class="code-header">fn <a href="trait.Session.html#tymethod.export_keying_material" class="fnname">export_keying_material</a>(<br> &self,<br> output: &mut [u8],<br> label: &[u8],<br> context: Option<&[u8]><br>) -> Result<(), <a class="enum" href="enum.TLSError.html" title="enum rustls::TLSError">TLSError</a>></h4></section></summary><div class='docblock'>Derives key material from the agreed session secrets. <a href="trait.Session.html#tymethod.export_keying_material">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_negotiated_ciphersuite" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#762-766">source</a><a href="#method.get_negotiated_ciphersuite" class="anchor"></a><h4 class="code-header">fn <a href="trait.Session.html#tymethod.get_negotiated_ciphersuite" class="fnname">get_negotiated_ciphersuite</a>(&self) -> Option<&'static <a class="struct" href="struct.SupportedCipherSuite.html" title="struct rustls::SupportedCipherSuite">SupportedCipherSuite</a>></h4></section></summary><div class='docblock'>Retrieves the ciphersuite agreed with the peer. <a href="trait.Session.html#tymethod.get_negotiated_ciphersuite">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.complete_io" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/rustls/session.rs.html#164-209">source</a><a href="#method.complete_io" class="anchor"></a><h4 class="code-header">fn <a href="trait.Session.html#method.complete_io" class="fnname">complete_io</a><T>(&mut self, io: &mut T) -> Result<(usize, usize), Error><span class="where fmt-newline">where<br> Self: Sized,<br> T: Read + Write,</span></h4></section></summary><div class='docblock'>This function uses <code>io</code> to complete any outstanding IO for |
| this session. <a href="trait.Session.html#method.complete_io">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Write-for-ClientSession" class="impl has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#787-814">source</a><a href="#impl-Write-for-ClientSession" class="anchor"></a><h3 class="code-header">impl Write for <a class="struct" href="struct.ClientSession.html" title="struct rustls::ClientSession">ClientSession</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#798-800">source</a><a href="#method.write" class="anchor"></a><h4 class="code-header">fn <a class="fnname">write</a>(&mut self, buf: &[u8]) -> Result<usize></h4></section></summary><div class="docblock"><p>Send the plaintext <code>buf</code> to the peer, encrypting |
| and authenticating it. Once this function succeeds |
| you should call <code>write_tls</code> which will output the |
| corresponding TLS records.</p> |
| <p>This function buffers plaintext sent before the |
| TLS handshake completes, and sends it as soon |
| as it can. This buffer is of <em>unlimited size</em> so |
| writing much data before it can be sent will |
| cause excess memory usage.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_vectored" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#802-808">source</a><a href="#method.write_vectored" class="anchor"></a><h4 class="code-header">fn <a class="fnname">write_vectored</a>(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize></h4></section></summary><div class='docblock'>Like <a href="Write::write"><code>write</code></a>, except that it writes from a slice of buffers. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.flush" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/rustls/client/mod.rs.html#810-813">source</a><a href="#method.flush" class="anchor"></a><h4 class="code-header">fn <a class="fnname">flush</a>(&mut self) -> Result<()></h4></section></summary><div class='docblock'>Flush this output stream, ensuring that all intermediately buffered |
| contents reach their destination. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_write_vectored" class="method trait-impl has-srclink"><a href="#method.is_write_vectored" class="anchor"></a><h4 class="code-header">fn <a class="fnname">is_write_vectored</a>(&self) -> bool</h4></section></summary><div class='docblock'>Determines if this <code>Write</code>r has an efficient <a href="Write::write_vectored"><code>write_vectored</code></a> |
| implementation. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_all" class="method trait-impl has-srclink"><a href="#method.write_all" class="anchor"></a><h4 class="code-header">fn <a class="fnname">write_all</a>(&mut self, buf: &[u8]) -> Result<(), Error></h4></section></summary><div class='docblock'>Attempts to write an entire buffer into this writer. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_all_vectored" class="method trait-impl has-srclink"><a href="#method.write_all_vectored" class="anchor"></a><h4 class="code-header">fn <a class="fnname">write_all_vectored</a>(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error></h4></section></summary><div class='docblock'>Attempts to write multiple buffers into this writer. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_fmt" class="method trait-impl has-srclink"><a href="#method.write_fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">write_fmt</a>(&mut self, fmt: Arguments<'_>) -> Result<(), Error></h4></section></summary><div class='docblock'>Writes a formatted string into this writer, returning any error |
| encountered. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.by_ref-1" class="method trait-impl has-srclink"><a href="#method.by_ref-1" class="anchor"></a><h4 class="code-header">fn <a class="fnname">by_ref</a>(&mut self) -> &mut Self</h4></section></summary><div class='docblock'>Creates a “by reference” adapter for this instance of <code>Write</code>. <a>Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-ClientSession" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-ClientSession" class="anchor"></a><h3 class="code-header">impl !RefUnwindSafe for <a class="struct" href="struct.ClientSession.html" title="struct rustls::ClientSession">ClientSession</a></h3></section><section id="impl-Send-for-ClientSession" class="impl has-srclink"><a href="#impl-Send-for-ClientSession" class="anchor"></a><h3 class="code-header">impl Send for <a class="struct" href="struct.ClientSession.html" title="struct rustls::ClientSession">ClientSession</a></h3></section><section id="impl-Sync-for-ClientSession" class="impl has-srclink"><a href="#impl-Sync-for-ClientSession" class="anchor"></a><h3 class="code-header">impl Sync for <a class="struct" href="struct.ClientSession.html" title="struct rustls::ClientSession">ClientSession</a></h3></section><section id="impl-Unpin-for-ClientSession" class="impl has-srclink"><a href="#impl-Unpin-for-ClientSession" class="anchor"></a><h3 class="code-header">impl Unpin for <a class="struct" href="struct.ClientSession.html" title="struct rustls::ClientSession">ClientSession</a></h3></section><section id="impl-UnwindSafe-for-ClientSession" class="impl has-srclink"><a href="#impl-UnwindSafe-for-ClientSession" class="anchor"></a><h3 class="code-header">impl !UnwindSafe for <a class="struct" href="struct.ClientSession.html" title="struct rustls::ClientSession">ClientSession</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-ClientSession" class="impl has-srclink"><a href="#impl-Any-for-ClientSession" class="anchor"></a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where<br> T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-ClientSession" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-ClientSession" class="anchor"></a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-ClientSession" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-ClientSession" class="anchor"></a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-ClientSession" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-ClientSession" class="anchor"></a><h3 class="code-header">impl<T> From<T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-ClientSession" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-ClientSession" class="anchor"></a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">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>[From]<T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-ClientSession" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-ClientSession" class="anchor"></a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-ClientSession" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-ClientSession" class="anchor"></a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = <U as TryFrom<T>>::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="rustls" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
