diff options
| author | 2015-06-29 20:16:15 +0000 | |
|---|---|---|
| committer | 2015-06-29 20:16:15 +0000 | |
| commit | 64106c4d3d4ddba8c7bc2af75376e6d3d3d75601 (patch) | |
| tree | 8c64d6e8be006486d975a651505fbbde61365cd6 /openssl/ssl/error | |
| download | irsc-64106c4d3d4ddba8c7bc2af75376e6d3d3d75601.tar.gz irsc-64106c4d3d4ddba8c7bc2af75376e6d3d3d75601.tar.xz irsc-64106c4d3d4ddba8c7bc2af75376e6d3d3d75601.zip | |
Update documentationgh-pages
Diffstat (limited to 'openssl/ssl/error')
| -rw-r--r-- | openssl/ssl/error/enum.OpensslError.html | 120 | ||||
| -rw-r--r-- | openssl/ssl/error/enum.SslError.html | 119 | ||||
| -rw-r--r-- | openssl/ssl/error/index.html | 121 | ||||
| -rw-r--r-- | openssl/ssl/error/sidebar-items.js | 1 |
4 files changed, 361 insertions, 0 deletions
diff --git a/openssl/ssl/error/enum.OpensslError.html b/openssl/ssl/error/enum.OpensslError.html new file mode 100644 index 0000000..ea81de3 --- /dev/null +++ b/openssl/ssl/error/enum.OpensslError.html @@ -0,0 +1,120 @@ +<!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 `OpensslError` enum in crate `openssl`."> + <meta name="keywords" content="rust, rustlang, rust-lang, OpensslError"> + + <title>openssl::ssl::error::OpensslError - 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>::<wbr><a href='index.html'>error</a></p><script>window.sidebarCurrent = {name: 'OpensslError', ty: 'enum', 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 enum"> +<h1 class='fqn'><span class='in-band'>Enum <a href='../../index.html'>openssl</a>::<wbr><a href='../index.html'>ssl</a>::<wbr><a href='index.html'>error</a>::<wbr><a class='enum' href=''>OpensslError</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-8483' class='srclink' href='../../../src/openssl/ssl/error.rs.html#64-74' title='goto source code'>[src]</a></span></h1> +<pre class='rust enum'>pub enum OpensslError { + UnknownError { + library: <a class='struct' href='http://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>, + function: <a class='struct' href='http://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>, + reason: <a class='struct' href='http://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>, + }, +}</pre><div class='docblock'><p>An error from the OpenSSL library</p> +</div><h2 class='variants'>Variants</h2> +<table><tr><td id='variant.UnknownError'><code>UnknownError</code></td><td><div class='docblock'><p>An unknown error</p> +</div><h3 class='fields'>Fields</h3> + + <table><tr><td id='variant.UnknownError.field.library'><code>library</code></td><td><div class='docblock'><p>The library reporting the error</p> +</div></td></tr><tr><td id='variant.UnknownError.field.function'><code>function</code></td><td><div class='docblock'><p>The function reporting the error</p> +</div></td></tr><tr><td id='variant.UnknownError.field.reason'><code>reason</code></td><td><div class='docblock'><p>The reason for the error</p> +</div></td></tr></table></td></tr></table><h2 id='implementations'>Trait Implementations</h2><h3 id='derived_implementations'>Derived Implementations </h3><h3 class='impl'><code>impl <a class='trait' href='http://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html' title='core::cmp::Eq'>Eq</a> for <a class='enum' href='../../../openssl/ssl/error/enum.OpensslError.html' title='openssl::ssl::error::OpensslError'>OpensslError</a></code></h3><div class='impl-items'></div><h3 class='impl'><code>impl <a class='trait' href='http://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html' title='core::cmp::PartialEq'>PartialEq</a> for <a class='enum' href='../../../openssl/ssl/error/enum.OpensslError.html' title='openssl::ssl::error::OpensslError'>OpensslError</a></code></h3><div class='impl-items'><h4 id='method.eq' class='method'><code>fn <a href='http://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.eq' class='fnname'>eq</a>(&self, __arg_0: &<a class='enum' href='../../../openssl/ssl/error/enum.OpensslError.html' title='openssl::ssl::error::OpensslError'>OpensslError</a>) -> <a href='http://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4> +<h4 id='method.ne' class='method'><code>fn <a href='http://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&self, __arg_0: &<a class='enum' href='../../../openssl/ssl/error/enum.OpensslError.html' title='openssl::ssl::error::OpensslError'>OpensslError</a>) -> <a href='http://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4> +</div><h3 class='impl'><code>impl <a class='trait' href='http://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title='core::clone::Clone'>Clone</a> for <a class='enum' href='../../../openssl/ssl/error/enum.OpensslError.html' title='openssl::ssl::error::OpensslError'>OpensslError</a></code></h3><div class='impl-items'><h4 id='method.clone' class='method'><code>fn <a href='http://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone' class='fnname'>clone</a>(&self) -> <a class='enum' href='../../../openssl/ssl/error/enum.OpensslError.html' title='openssl::ssl::error::OpensslError'>OpensslError</a></code></h4> +<h4 id='method.clone_from' class='method'><code>fn <a href='http://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: &Self)</code></h4> +</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='enum' href='../../../openssl/ssl/error/enum.OpensslError.html' title='openssl::ssl::error::OpensslError'>OpensslError</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, __arg_0: &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></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 diff --git a/openssl/ssl/error/enum.SslError.html b/openssl/ssl/error/enum.SslError.html new file mode 100644 index 0000000..d201d68 --- /dev/null +++ b/openssl/ssl/error/enum.SslError.html @@ -0,0 +1,119 @@ +<!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 `SslError` enum in crate `openssl`."> + <meta name="keywords" content="rust, rustlang, rust-lang, SslError"> + + <title>openssl::ssl::error::SslError - 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>::<wbr><a href='index.html'>error</a></p><script>window.sidebarCurrent = {name: 'SslError', ty: 'enum', 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 enum"> +<h1 class='fqn'><span class='in-band'>Enum <a href='../../index.html'>openssl</a>::<wbr><a href='../index.html'>ssl</a>::<wbr><a href='index.html'>error</a>::<wbr><a class='enum' href=''>SslError</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-8229' class='srclink' href='../../../src/openssl/ssl/error.rs.html#14-21' title='goto source code'>[src]</a></span></h1> +<pre class='rust enum'>pub enum SslError { + StreamError(<a class='struct' href='http://doc.rust-lang.org/nightly/std/io/error/struct.Error.html' title='std::io::error::Error'>Error</a>), + SslSessionClosed, + OpenSslErrors(<a class='struct' href='http://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html' title='collections::vec::Vec'>Vec</a><<a class='enum' href='../../../openssl/ssl/error/enum.OpensslError.html' title='openssl::ssl::error::OpensslError'>OpensslError</a>>), +}</pre><div class='docblock'><p>An SSL error</p> +</div><h2 class='variants'>Variants</h2> +<table><tr><td id='variant.StreamError'><code>StreamError</code></td><td><div class='docblock'><p>The underlying stream reported an error</p> +</div></td></tr><tr><td id='variant.SslSessionClosed'><code>SslSessionClosed</code></td><td><div class='docblock'><p>The SSL session has been closed by the other end</p> +</div></td></tr><tr><td id='variant.OpenSslErrors'><code>OpenSslErrors</code></td><td><div class='docblock'><p>An error in the OpenSSL library</p> +</div></td></tr></table><h2 id='methods'>Methods</h2><h3 class='impl'><code>impl <a class='enum' href='../../../openssl/ssl/error/enum.SslError.html' title='openssl::ssl::error::SslError'>SslError</a></code></h3><div class='impl-items'><h4 id='method.get' class='method'><code>fn <a href='#method.get' class='fnname'>get</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 <code>OpenSslErrors</code> with the current contents of the error +stack.</p> +</div><h4 id='method.from_error' class='method'><code>fn <a href='#method.from_error' class='fnname'>from_error</a>(err: <a class='type' href='../../../libc/types/os/arch/c95/type.c_ulong.html' title='libc::types::os::arch::c95::c_ulong'>c_ulong</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 an <code>SslError</code> from the raw numeric error code.</p> +</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><code>impl <a class='trait' href='http://doc.rust-lang.org/nightly/core/fmt/trait.Display.html' title='core::fmt::Display'>Display</a> for <a class='enum' href='../../../openssl/ssl/error/enum.SslError.html' title='openssl::ssl::error::SslError'>SslError</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.Display.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/std/error/trait.Error.html' title='std::error::Error'>Error</a> for <a class='enum' href='../../../openssl/ssl/error/enum.SslError.html' title='openssl::ssl::error::SslError'>SslError</a></code></h3><div class='impl-items'><h4 id='method.description' class='method'><code>fn <a href='http://doc.rust-lang.org/nightly/std/error/trait.Error.html#method.description' class='fnname'>description</a>(&self) -> &<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a></code></h4> +<h4 id='method.cause' class='method'><code>fn <a href='http://doc.rust-lang.org/nightly/std/error/trait.Error.html#method.cause' class='fnname'>cause</a>(&self) -> <a class='enum' href='http://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a><&<a class='trait' href='http://doc.rust-lang.org/nightly/std/error/trait.Error.html' title='std::error::Error'>Error</a>></code></h4> +</div><h3 id='derived_implementations'>Derived Implementations </h3><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='enum' href='../../../openssl/ssl/error/enum.SslError.html' title='openssl::ssl::error::SslError'>SslError</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, __arg_0: &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></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 diff --git a/openssl/ssl/error/index.html b/openssl/ssl/error/index.html new file mode 100644 index 0000000..8b80ea3 --- /dev/null +++ b/openssl/ssl/error/index.html @@ -0,0 +1,121 @@ +<!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 `error` mod in crate `openssl`."> + <meta name="keywords" content="rust, rustlang, rust-lang, error"> + + <title>openssl::ssl::error - 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: 'error', ty: 'mod', 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 mod"> +<h1 class='fqn'><span class='in-band'>Module <a href='../../index.html'>openssl</a>::<wbr><a href='../index.html'>ssl</a>::<wbr><a class='mod' href=''>error</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-8219' class='srclink' href='../../../src/openssl/ssl/error.rs.html#1-138' title='goto source code'>[src]</a></span></h1> +<h2 id='reexports' class='section-header'><a href="#reexports">Reexports</a></h2> +<table><tr><td><code>pub use self::<a class='enum' href='../../../openssl/ssl/error/enum.SslError.html' title='openssl::ssl::error::SslError'>SslError</a>::*;</code></td></tr><tr><td><code>pub use self::<a class='enum' href='../../../openssl/ssl/error/enum.OpensslError.html' title='openssl::ssl::error::OpensslError'>OpensslError</a>::*;</code></td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2> +<table> + <tr class=' module-item'> + <td><a class='enum' href='enum.OpensslError.html' + title='openssl::ssl::error::OpensslError'>OpensslError</a></td> + <td class='docblock short'> + <p>An error from the OpenSSL library</p> + + </td> + </tr> + + <tr class=' module-item'> + <td><a class='enum' href='enum.SslError.html' + title='openssl::ssl::error::SslError'>SslError</a></td> + <td class='docblock short'> + <p>An SSL error</p> + + </td> + </tr> + </table></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 diff --git a/openssl/ssl/error/sidebar-items.js b/openssl/ssl/error/sidebar-items.js new file mode 100644 index 0000000..df0c1b7 --- /dev/null +++ b/openssl/ssl/error/sidebar-items.js @@ -0,0 +1 @@ +initSidebarItems({"enum":[["OpensslError","An error from the OpenSSL library"],["SslError","An SSL error"]]});
\ No newline at end of file |