yume/juniper
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
juniper/hyper/net/struct.Openssl.html

151 lines
13 KiB
HTML
Raw Normal View History

Update documentation for Juniper
2016-09-11 13:41:24 -05:00
<!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 `Openssl` struct in crate `hyper`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Openssl">
<title>hyper::net::Openssl - Rust</title>
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">
</head>
<body class="rustdoc">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class='location'><a href='../index.html'>hyper</a>::<wbr><a href='index.html'>net</a></p><script>window.sidebarCurrent = {name: 'Openssl', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content struct">
<h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>hyper</a>::<wbr><a href='index.html'>net</a>::<wbr><a class='struct' href=''>Openssl</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'>&#x2212;</span>]
</a>
</span><a id='src-7124' class='srclink' href='../../src/hyper/net.rs.html#646-649' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Openssl {
pub context: <a class='struct' href='https://doc.rust-lang.org/nightly/alloc/arc/struct.Arc.html' title='alloc::arc::Arc'>Arc</a>&lt;<a class='struct' href='../../openssl/ssl/struct.SslContext.html' title='openssl::ssl::SslContext'>SslContext</a>&gt;,
}</pre><div class='docblock'><p>An implementation of <code>Ssl</code> for OpenSSL.</p>
<h1 id='example' class='section-header'><a href='#example'>Example</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>hyper</span>::<span class='ident'>Server</span>;
<span class='kw'>use</span> <span class='ident'>hyper</span>::<span class='ident'>net</span>::<span class='ident'>Openssl</span>;
<span class='kw'>let</span> <span class='ident'>ssl</span> <span class='op'>=</span> <span class='ident'>Openssl</span>::<span class='ident'>with_cert_and_key</span>(<span class='string'>&quot;/home/foo/cert&quot;</span>, <span class='string'>&quot;/home/foo/key&quot;</span>).<span class='ident'>unwrap</span>();
<span class='ident'>Server</span>::<span class='ident'>https</span>(<span class='string'>&quot;0.0.0.0:443&quot;</span>, <span class='ident'>ssl</span>).<span class='ident'>unwrap</span>();</pre>
<p>For complete control, create a <code>SslContext</code> with the options you desire
and then create `Openssl { context: ctx }</p>
</div><h2 class='fields'>Fields</h2><span id='structfield.context' class='structfield'><code>context: <a class='struct' href='https://doc.rust-lang.org/nightly/alloc/arc/struct.Arc.html' title='alloc::arc::Arc'>Arc</a>&lt;<a class='struct' href='../../openssl/ssl/struct.SslContext.html' title='openssl::ssl::SslContext'>SslContext</a>&gt;</code>
</span><span class='stab '></span><div class='docblock'><p>The <code>SslContext</code> from openssl crate.</p>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class='struct' href='../../hyper/net/struct.Openssl.html' title='hyper::net::Openssl'>Openssl</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-7168' class='srclink' href='../../src/hyper/net.rs.html#707-718' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.with_cert_and_key' class='method'><code>fn <a href='#method.with_cert_and_key' class='fnname'>with_cert_and_key</a>&lt;C,&nbsp;K&gt;(cert: C, key: K) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a>&lt;<a class='struct' href='../../hyper/net/struct.Openssl.html' title='hyper::net::Openssl'>Openssl</a>,&nbsp;<a class='enum' href='../../openssl/ssl/error/enum.SslError.html' title='openssl::ssl::error::SslError'>SslError</a>&gt; <span class='where'>where C: <a class='trait' href='https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html' title='core::convert::AsRef'>AsRef</a>&lt;<a class='struct' href='https://doc.rust-lang.org/nightly/std/path/struct.Path.html' title='std::path::Path'>Path</a>&gt;, K: <a class='trait' href='https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html' title='core::convert::AsRef'>AsRef</a>&lt;<a class='struct' href='https://doc.rust-lang.org/nightly/std/path/struct.Path.html' title='std::path::Path'>Path</a>&gt;</span></code></h4>
<div class='docblock'><p>Ease creating an <code>Openssl</code> with a certificate and key.</p>
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title='core::clone::Clone'>Clone</a> for <a class='struct' href='../../hyper/net/struct.Openssl.html' title='hyper::net::Openssl'>Openssl</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-7114' class='srclink' href='../../src/hyper/net.rs.html#645' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class='struct' href='../../hyper/net/struct.Openssl.html' title='hyper::net::Openssl'>Openssl</a></code></h4>
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: &amp;Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></h4>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html' title='core::fmt::Debug'>Debug</a> for <a class='struct' href='../../hyper/net/struct.Openssl.html' title='hyper::net::Openssl'>Openssl</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-7118' class='srclink' href='../../src/hyper/net.rs.html#645' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class='struct' href='https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html' title='core::fmt::Formatter'>Formatter</a>) -&gt; <a class='type' href='https://doc.rust-lang.org/nightly/core/fmt/type.Result.html' title='core::fmt::Result'>Result</a></code></h4>
<div class='docblock'><p>Formats the value using the given formatter.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html' title='core::default::Default'>Default</a> for <a class='struct' href='../../hyper/net/struct.Openssl.html' title='hyper::net::Openssl'>Openssl</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-7161' class='srclink' href='../../src/hyper/net.rs.html#695-705' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.default' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -&gt; <a class='struct' href='../../hyper/net/struct.Openssl.html' title='hyper::net::Openssl'>Openssl</a></code></h4>
<div class='docblock'><p>Returns the &quot;default value&quot; for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='../../hyper/net/trait.Ssl.html' title='hyper::net::Ssl'>Ssl</a> for <a class='struct' href='../../hyper/net/struct.Openssl.html' title='hyper::net::Openssl'>Openssl</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-7183' class='srclink' href='../../src/hyper/net.rs.html#720-738' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='associatedtype.Stream' class='type'><code>type <a href='../../hyper/net/trait.Ssl.html#associatedtype.Stream' class='type'>Stream</a> = <a class='struct' href='../../openssl/ssl/struct.SslStream.html' title='openssl::ssl::SslStream'>SslStream</a>&lt;<a class='struct' href='../../hyper/net/struct.HttpStream.html' title='hyper::net::HttpStream'>HttpStream</a>&gt;</code></h4>
<div class='docblock'><p>The protected stream.</p>
</div><h4 id='method.wrap_client' class='method'><code>fn <a href='../../hyper/net/trait.Ssl.html#tymethod.wrap_client' class='fnname'>wrap_client</a>(&amp;self, stream: <a class='struct' href='../../hyper/net/struct.HttpStream.html' title='hyper::net::HttpStream'>HttpStream</a>, host: &amp;<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>) -&gt; <a class='type' href='../../hyper/error/type.Result.html' title='hyper::error::Result'>Result</a>&lt;Self::<a class='trait' href='../../hyper/net/trait.Ssl.html' title='hyper::net::Ssl'>Stream</a>&gt;</code></h4>
<div class='docblock'><p>Wrap a client stream with SSL.</p>
</div><h4 id='method.wrap_server' class='method'><code>fn <a href='../../hyper/net/trait.Ssl.html#tymethod.wrap_server' class='fnname'>wrap_server</a>(&amp;self, stream: <a class='struct' href='../../hyper/net/struct.HttpStream.html' title='hyper::net::HttpStream'>HttpStream</a>) -&gt; <a class='type' href='../../hyper/error/type.Result.html' title='hyper::error::Result'>Result</a>&lt;Self::<a class='trait' href='../../hyper/net/trait.Ssl.html' title='hyper::net::Ssl'>Stream</a>&gt;</code></h4>
<div class='docblock'><p>Wrap a server stream with SSL.</p>
</div></div></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "hyper";
window.playgroundUrl = "";
</script>
<script src="../../jquery.js"></script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>
Reference in a new issue Copy permalink