diff options
Diffstat (limited to 'openssl/ssl/struct.SslContext.html')
| -rw-r--r-- | openssl/ssl/struct.SslContext.html | 135 |
1 files changed, 135 insertions, 0 deletions
diff --git a/openssl/ssl/struct.SslContext.html b/openssl/ssl/struct.SslContext.html new file mode 100644 index 0000000..b41db15 --- /dev/null +++ b/openssl/ssl/struct.SslContext.html @@ -0,0 +1,135 @@ +<!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 `SslContext` struct in crate `openssl`."> + <meta name="keywords" content="rust, rustlang, rust-lang, SslContext"> + + <title>openssl::ssl::SslContext - Rust</title> + + <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]--> + + + + <section class="sidebar"> + + <p class='location'><a href='../index.html'>openssl</a>::<wbr><a href='index.html'>ssl</a></p><script>window.sidebarCurrent = {name: 'SslContext', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script> + </section> + + <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'>openssl</a>::<wbr><a href='index.html'>ssl</a>::<wbr><a class='struct' href=''>SslContext</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 id='src-11500' class='srclink' href='../../src/openssl/ssl/mod.rs.html#346-348' title='goto source code'>[src]</a></span></h1> +<pre class='rust struct'>pub struct SslContext { + // some fields omitted +}</pre><div class='docblock'><p>An SSL context object</p> +</div><h2 id='methods'>Methods</h2><h3 class='impl'><code>impl <a class='struct' href='../../openssl/ssl/struct.SslContext.html' title='openssl::ssl::SslContext'>SslContext</a></code></h3><div class='impl-items'><h4 id='method.new' class='method'><code>fn <a href='#method.new' class='fnname'>new</a>(method: <a class='enum' href='../../openssl/ssl/enum.SslMethod.html' title='openssl::ssl::SslMethod'>SslMethod</a>) -> <a class='enum' href='http://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><<a class='struct' href='../../openssl/ssl/struct.SslContext.html' title='openssl::ssl::SslContext'>SslContext</a>, <a class='enum' href='../../openssl/ssl/error/enum.SslError.html' title='openssl::ssl::error::SslError'>SslError</a>></code></h4> +<div class='docblock'><p>Creates a new SSL context.</p> +</div><h4 id='method.set_verify' class='method'><code>fn <a href='#method.set_verify' class='fnname'>set_verify</a>(&mut self, mode: <a class='struct' href='../../openssl/ssl/struct.SslVerifyMode.html' title='openssl::ssl::SslVerifyMode'>SslVerifyMode</a>, verify: <a class='enum' href='http://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a><<a class='type' href='../../openssl/ssl/type.VerifyCallback.html' title='openssl::ssl::VerifyCallback'>VerifyCallback</a>>)</code></h4> +<div class='docblock'><p>Configures the certificate verification method for new connections.</p> +</div><h4 id='method.set_verify_with_data' class='method'><code>fn <a href='#method.set_verify_with_data' class='fnname'>set_verify_with_data</a><T>(&mut self, mode: <a class='struct' href='../../openssl/ssl/struct.SslVerifyMode.html' title='openssl::ssl::SslVerifyMode'>SslVerifyMode</a>, verify: <a class='type' href='../../openssl/ssl/type.VerifyCallbackData.html' title='openssl::ssl::VerifyCallbackData'>VerifyCallbackData</a><T>, data: T) <span class='where'>where T: <a class='trait' href='http://doc.rust-lang.org/nightly/core/any/trait.Any.html' title='core::any::Any'>Any</a> + 'static</span></code></h4> +<div class='docblock'><p>Configures the certificate verification method for new connections also +carrying supplied data.</p> +</div><h4 id='method.set_verify_depth' class='method'><code>fn <a href='#method.set_verify_depth' class='fnname'>set_verify_depth</a>(&mut self, depth: <a href='http://doc.rust-lang.org/nightly/std/primitive.u32.html'>u32</a>)</code></h4> +<div class='docblock'><p>Sets verification depth</p> +</div><h4 id='method.set_read_ahead' class='method'><code>fn <a href='#method.set_read_ahead' class='fnname'>set_read_ahead</a>(&self, m: <a href='http://doc.rust-lang.org/nightly/std/primitive.u32.html'>u32</a>)</code></h4> +<h4 id='method.set_CA_file' class='method'><code>fn <a href='#method.set_CA_file' class='fnname'>set_CA_file</a><P: <a class='trait' href='http://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html' title='core::convert::AsRef'>AsRef</a><<a class='struct' href='http://doc.rust-lang.org/nightly/std/path/struct.Path.html' title='std::path::Path'>Path</a>>>(&mut self, file: P) -> <a class='enum' href='http://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>, <a class='enum' href='../../openssl/ssl/error/enum.SslError.html' title='openssl::ssl::error::SslError'>SslError</a>></code></h4> +<div class='docblock'><p>Specifies the file that contains trusted CA certificates.</p> +</div><h4 id='method.set_certificate_file' class='method'><code>fn <a href='#method.set_certificate_file' class='fnname'>set_certificate_file</a><P: <a class='trait' href='http://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html' title='core::convert::AsRef'>AsRef</a><<a class='struct' href='http://doc.rust-lang.org/nightly/std/path/struct.Path.html' title='std::path::Path'>Path</a>>>(&mut self, file: P, file_type: <a class='enum' href='../../openssl/x509/enum.X509FileType.html' title='openssl::x509::X509FileType'>X509FileType</a>) -> <a class='enum' href='http://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>, <a class='enum' href='../../openssl/ssl/error/enum.SslError.html' title='openssl::ssl::error::SslError'>SslError</a>></code></h4> +<div class='docblock'><p>Specifies the file that contains certificate</p> +</div><h4 id='method.set_certificate' class='method'><code>fn <a href='#method.set_certificate' class='fnname'>set_certificate</a>(&mut self, cert: &<a class='struct' href='../../openssl/x509/struct.X509.html' title='openssl::x509::X509'>X509</a>) -> <a class='enum' href='http://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>, <a class='enum' href='../../openssl/ssl/error/enum.SslError.html' title='openssl::ssl::error::SslError'>SslError</a>></code></h4> +<div class='docblock'><p>Specifies the certificate</p> +</div><h4 id='method.add_extra_chain_cert' class='method'><code>fn <a href='#method.add_extra_chain_cert' class='fnname'>add_extra_chain_cert</a>(&mut self, cert: &<a class='struct' href='../../openssl/x509/struct.X509.html' title='openssl::x509::X509'>X509</a>) -> <a class='enum' href='http://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>, <a class='enum' href='../../openssl/ssl/error/enum.SslError.html' title='openssl::ssl::error::SslError'>SslError</a>></code></h4> +<div class='docblock'><p>Adds a certificate to the certificate chain presented together with the +certificate specified using set_certificate()</p> +</div><h4 id='method.set_private_key_file' class='method'><code>fn <a href='#method.set_private_key_file' class='fnname'>set_private_key_file</a><P: <a class='trait' href='http://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html' title='core::convert::AsRef'>AsRef</a><<a class='struct' href='http://doc.rust-lang.org/nightly/std/path/struct.Path.html' title='std::path::Path'>Path</a>>>(&mut self, file: P, file_type: <a class='enum' href='../../openssl/x509/enum.X509FileType.html' title='openssl::x509::X509FileType'>X509FileType</a>) -> <a class='enum' href='http://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>, <a class='enum' href='../../openssl/ssl/error/enum.SslError.html' title='openssl::ssl::error::SslError'>SslError</a>></code></h4> +<div class='docblock'><p>Specifies the file that contains private key</p> +</div><h4 id='method.set_private_key' class='method'><code>fn <a href='#method.set_private_key' class='fnname'>set_private_key</a>(&mut self, key: &<a class='struct' href='../../openssl/crypto/pkey/struct.PKey.html' title='openssl::crypto::pkey::PKey'>PKey</a>) -> <a class='enum' href='http://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>, <a class='enum' href='../../openssl/ssl/error/enum.SslError.html' title='openssl::ssl::error::SslError'>SslError</a>></code></h4> +<div class='docblock'><p>Specifies the private key</p> +</div><h4 id='method.check_private_key' class='method'><code>fn <a href='#method.check_private_key' class='fnname'>check_private_key</a>(&mut self) -> <a class='enum' href='http://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>, <a class='enum' href='../../openssl/ssl/error/enum.SslError.html' title='openssl::ssl::error::SslError'>SslError</a>></code></h4> +<div class='docblock'><p>Check consistency of private key and certificate</p> +</div><h4 id='method.set_cipher_list' class='method'><code>fn <a href='#method.set_cipher_list' class='fnname'>set_cipher_list</a>(&mut self, cipher_list: &<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>) -> <a class='enum' href='http://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>, <a class='enum' href='../../openssl/ssl/error/enum.SslError.html' title='openssl::ssl::error::SslError'>SslError</a>></code></h4> +<h4 id='method.set_options' class='method'><code>fn <a href='#method.set_options' class='fnname'>set_options</a>(&mut self, option: <a class='struct' href='../../openssl/ssl/struct.SslContextOptions.html' title='openssl::ssl::SslContextOptions'>SslContextOptions</a>) -> <a class='struct' href='../../openssl/ssl/struct.SslContextOptions.html' title='openssl::ssl::SslContextOptions'>SslContextOptions</a></code></h4> +<h4 id='method.get_options' class='method'><code>fn <a href='#method.get_options' class='fnname'>get_options</a>(&mut self) -> <a class='struct' href='../../openssl/ssl/struct.SslContextOptions.html' title='openssl::ssl::SslContextOptions'>SslContextOptions</a></code></h4> +<h4 id='method.clear_options' class='method'><code>fn <a href='#method.clear_options' class='fnname'>clear_options</a>(&mut self, option: <a class='struct' href='../../openssl/ssl/struct.SslContextOptions.html' title='openssl::ssl::SslContextOptions'>SslContextOptions</a>) -> <a class='struct' href='../../openssl/ssl/struct.SslContextOptions.html' title='openssl::ssl::SslContextOptions'>SslContextOptions</a></code></h4> +</div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><code>impl <a class='trait' href='http://doc.rust-lang.org/nightly/core/marker/trait.Send.html' title='core::marker::Send'>Send</a> for <a class='struct' href='../../openssl/ssl/struct.SslContext.html' title='openssl::ssl::SslContext'>SslContext</a></code></h3><div class='impl-items'></div><h3 class='impl'><code>impl <a class='trait' href='http://doc.rust-lang.org/nightly/core/marker/trait.Sync.html' title='core::marker::Sync'>Sync</a> for <a class='struct' href='../../openssl/ssl/struct.SslContext.html' title='openssl::ssl::SslContext'>SslContext</a></code></h3><div class='impl-items'></div><h3 class='impl'><code>impl <a class='trait' href='http://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html' title='core::fmt::Debug'>Debug</a> for <a class='struct' href='../../openssl/ssl/struct.SslContext.html' title='openssl::ssl::SslContext'>SslContext</a></code></h3><div class='impl-items'><h4 id='method.fmt' class='method'><code>fn <a href='http://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#method.fmt' class='fnname'>fmt</a>(&self, fmt: &mut <a class='struct' href='http://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html' title='core::fmt::Formatter'>Formatter</a>) -> <a class='type' href='http://doc.rust-lang.org/nightly/core/fmt/type.Result.html' title='core::fmt::Result'>Result</a></code></h4> +</div><h3 class='impl'><code>impl <a class='trait' href='http://doc.rust-lang.org/nightly/core/ops/trait.Drop.html' title='core::ops::Drop'>Drop</a> for <a class='struct' href='../../openssl/ssl/struct.SslContext.html' title='openssl::ssl::SslContext'>SslContext</a></code></h3><div class='impl-items'><h4 id='method.drop' class='method'><code>fn <a href='http://doc.rust-lang.org/nightly/core/ops/trait.Drop.html#method.drop' class='fnname'>drop</a>(&mut self)</code></h4> +</div></section> + <section id='search' class="content hidden"></section> + + <section class="footer"></section> + + <div id="help" class="hidden"> + <div class="shortcuts"> + <h1>Keyboard shortcuts</h1> + <dl> + <dt>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</dd> + </dl> + </div> + <div class="infos"> + <h1>Search tricks</h1> + <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>typedef</code> (or + <code>tdef</code>). + </p> + <p> + Search functions by type signature (e.g. + <code>vec -> usize</code>) + </p> + </div> + </div> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "openssl"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script async src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file |