mpvrc/tokio_native_tls/index.html

17 lines
No EOL
5.3 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="Async TLS streams"><title>tokio_native_tls - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="tokio_native_tls" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../tokio_native_tls/index.html">tokio_<wbr>native_<wbr>tls</a><span class="version">0.3.1</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#modules">Crate Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>tokio_native_tls</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/tokio_native_tls/lib.rs.html#1-384">Source</a> </span></div><details class="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="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="native_tls/index.html" title="mod tokio_native_tls::native_tls">native_<wbr>tls</a></div><div class="desc docblock-short">re-export native_tls</div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.AllowStd.html" title="struct tokio_native_tls::AllowStd">Allow<wbr>Std</a></div><div class="desc docblock-short">An intermediate wrapper for the inner stream <code>S</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.TlsAcceptor.html" title="struct tokio_native_tls::TlsAcceptor">TlsAcceptor</a></div><div class="desc docblock-short">A wrapper around a <code>native_tls::TlsAcceptor</code>, providing an async <code>accept</code>
method.</div></li><li><div class="item-name"><a class="struct" href="struct.TlsConnector.html" title="struct tokio_native_tls::TlsConnector">TlsConnector</a></div><div class="desc docblock-short">A wrapper around a <code>native_tls::TlsConnector</code>, providing an async <code>connect</code>
method.</div></li><li><div class="item-name"><a class="struct" href="struct.TlsStream.html" title="struct tokio_native_tls::TlsStream">TlsStream</a></div><div class="desc docblock-short">A wrapper around an underlying raw stream which implements the TLS or SSL
protocol.</div></li></ul></section></div></main></body></html>