blob: d9c159d6f710a55be27a48fb13f4e5f5957d9219 [file] [log] [blame]
<!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="Asynchronous TLS/SSL streams for Tokio using Rustls."><meta name="keywords" content="rust, rustlang, rust-lang, tokio_rustls"><title>tokio_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="../crates.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 mod crate"><!--[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">&#9776;</button><a class="sidebar-logo" href="../tokio_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="../tokio_rustls/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate tokio_rustls</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.22.0</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></section></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">Crate <a class="mod" href="#">tokio_rustls</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/tokio_rustls/lib.rs.html#1-293">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Asynchronous TLS/SSL streams for Tokio using <a href="https://github.com/ctz/rustls">Rustls</a>.</p>
</div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2><div class="item-table"><div class="item-row"><div class="item-left import-item" id="reexport.rustls"><code>pub use <a class="mod" href="../rustls/index.html" title="mod rustls">rustls</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.webpki"><code>pub use <a class="mod" href="../webpki/index.html" title="mod webpki">webpki</a>;</code></div></div></div><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="client/index.html" title="tokio_rustls::client mod">client</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="server/index.html" title="tokio_rustls::server mod">server</a></div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Accept.html" title="tokio_rustls::Accept struct">Accept</a></div><div class="item-right docblock-short">Future returned from <code>TlsAcceptor::accept</code> which will resolve
once the accept handshake has finished.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Connect.html" title="tokio_rustls::Connect struct">Connect</a></div><div class="item-right docblock-short">Future returned from <code>TlsConnector::connect</code> which will resolve
once the connection handshake has finished.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FailableAccept.html" title="tokio_rustls::FailableAccept struct">FailableAccept</a></div><div class="item-right docblock-short">Like <a href="struct.Accept.html" title="Accept">Accept</a>, but returns <code>IO</code> on failure.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FailableConnect.html" title="tokio_rustls::FailableConnect struct">FailableConnect</a></div><div class="item-right docblock-short">Like <a href="struct.Connect.html" title="Connect">Connect</a>, but returns <code>IO</code> on failure.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TlsAcceptor.html" title="tokio_rustls::TlsAcceptor struct">TlsAcceptor</a></div><div class="item-right docblock-short">A wrapper around a <code>rustls::ServerConfig</code>, providing an async <code>accept</code> method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TlsConnector.html" title="tokio_rustls::TlsConnector struct">TlsConnector</a></div><div class="item-right docblock-short">A wrapper around a <code>rustls::ClientConfig</code>, providing an async <code>connect</code> method.</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.TlsStream.html" title="tokio_rustls::TlsStream enum">TlsStream</a></div><div class="item-right docblock-short">Unified TLS stream type</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="tokio_rustls" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>