blob: 25785a004dd8a39ca3b1d7fac9f03be95e0e2a00 [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="Async TLS streams"><meta name="keywords" content="rust, rustlang, rust-lang, tokio_native_tls"><title>tokio_native_tls - 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_native_tls/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_native_tls/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_native_tls</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.3.1</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</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_native_tls</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_native_tls/lib.rs.html#1-384">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>Async TLS streams</p>
<p>This library is an implementation of TLS streams using the most appropriate
system library by default for negotiating the connection. That is, on
Windows this library uses SChannel, on OSX it uses SecureTransport, and on
other platforms it uses OpenSSL.</p>
<p>Each TLS stream implements the <code>Read</code> and <code>Write</code> traits to interact and
interoperate with the rest of the futures I/O ecosystem. Client connections
initiated from this crate verify hostnames automatically and by default.</p>
<p>This crate primarily exports this ability through two newtypes,
<code>TlsConnector</code> and <code>TlsAcceptor</code>. These newtypes augment the
functionality provided by the <code>native-tls</code> crate, on which this crate is
built. Configuration of TLS parameters is still primarily done through the
<code>native-tls</code> crate.</p>
</div></details><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="native_tls/index.html" title="tokio_native_tls::native_tls mod">native_tls</a></div><div class="item-right docblock-short">re-export native_tls</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.AllowStd.html" title="tokio_native_tls::AllowStd struct">AllowStd</a></div><div class="item-right docblock-short">An intermediate wrapper for the inner stream <code>S</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TlsAcceptor.html" title="tokio_native_tls::TlsAcceptor struct">TlsAcceptor</a></div><div class="item-right docblock-short">A wrapper around a <code>native_tls::TlsAcceptor</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_native_tls::TlsConnector struct">TlsConnector</a></div><div class="item-right docblock-short">A wrapper around a <code>native_tls::TlsConnector</code>, providing an async <code>connect</code>
method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TlsStream.html" title="tokio_native_tls::TlsStream struct">TlsStream</a></div><div class="item-right docblock-short">A wrapper around an underlying raw stream which implements the TLS or SSL
protocol.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="tokio_native_tls" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>