github-actions[bot]
28 lines
5.7 KiB
HTML
28 lines
5.7 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="API documentation for the Rust `tokio_native_tls` crate."><meta name="keywords" content="rust, rustlang, rust-lang, tokio_native_tls"><title>tokio_native_tls - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../tokio_native_tls/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Crate tokio_native_tls</p><div class="block version"><p>Version 0.3.0</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all tokio_native_tls's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li></ul></div><p class="location"></p><div id="sidebar-vars" data-name="tokio_native_tls" data-ty="mod" data-relpath="../"></div></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="">tokio_native_tls</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/tokio_native_tls/lib.rs.html#1-366" title="goto source code">[src]</a></span></h1><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><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2>
|
||
<table><tr class="module-item"><td><a class="mod" href="native_tls/index.html" title="tokio_native_tls::native_tls mod">native_tls</a></td><td class="docblock-short"><p>re-export native_tls</p>
|
||
</td></tr></table><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
||
<table><tr class="module-item"><td><a class="struct" href="struct.AllowStd.html" title="tokio_native_tls::AllowStd struct">AllowStd</a></td><td class="docblock-short"><p>An intermediate wrapper for the inner stream <code>S</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TlsAcceptor.html" title="tokio_native_tls::TlsAcceptor struct">TlsAcceptor</a></td><td class="docblock-short"><p>A wrapper around a <code>native_tls::TlsAcceptor</code>, providing an async <code>accept</code>
|
||
method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TlsConnector.html" title="tokio_native_tls::TlsConnector struct">TlsConnector</a></td><td class="docblock-short"><p>A wrapper around a <code>native_tls::TlsConnector</code>, providing an async <code>connect</code>
|
||
method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TlsStream.html" title="tokio_native_tls::TlsStream struct">TlsStream</a></td><td class="docblock-short"><p>A wrapper around an underlying raw stream which implements the TLS or SSL
|
||
protocol.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="tokio_native_tls"></div>
|
||
<script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |