Skip to content

Commit

Permalink
Updated the docs from the latest PR
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris Jones committed Jun 7, 2017
1 parent 24cfe8d commit ead7751
Show file tree
Hide file tree
Showing 112 changed files with 4,748 additions and 1,604 deletions.
5 changes: 0 additions & 5 deletions docs/COPYRIGHT.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,6 @@ included, and carry their own copyright notices and license terms:
Licensed under the SIL Open Font License, Version 1.1.
See Heuristica-LICENSE.txt.

* jQuery (jquery-2.1.4.min.js):

Copyright 2005, 2015 jQuery Foundation, Inc.
Licensed under the MIT license (see LICENSE-MIT.txt).

* rustdoc.css, main.js, and playpen.js:

Copyright 2015 The Rust Developers.
Expand Down
10 changes: 10 additions & 0 deletions docs/ceph_rust/error/RadosResult.t.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=type.RadosResult.html">
</head>
<body>
<p>Redirecting to <a href="type.RadosResult.html">type.RadosResult.html</a>...</p>
<script>location.replace("type.RadosResult.html" + location.search + location.hash);</script>
</body>
</html>
68 changes: 34 additions & 34 deletions docs/ceph_rust/error/enum.RadosError.html

Large diffs are not rendered by default.

24 changes: 16 additions & 8 deletions docs/ceph_rust/error/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,15 @@

<title>ceph_rust::error - Rust</title>

<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">


<link rel="shortcut icon" href="https://lambdastackio.github.io/static/images/favicon.ico">

</head>
<body class="rustdoc">
<body class="rustdoc mod">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
Expand All @@ -28,7 +29,7 @@

<nav class="sidebar">
<a href='../../ceph_rust/index.html'><img src='https://lambdastackio.github.io/static/images/lambdastack-200x200.png' alt='logo' width='100'></a>
<p class='location'><a href='../index.html'>ceph_rust</a></p><script>window.sidebarCurrent = {name: 'error', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script>
<p class='location'>Module error</p><div class="block items"><ul><li><a href="#enums">Enums</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../index.html'>ceph_rust</a></p><script>window.sidebarCurrent = {name: 'error', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script>
</nav>

<nav class="sub">
Expand All @@ -42,20 +43,28 @@
</form>
</nav>

<section id='main' class="content mod">
<h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>ceph_rust</a>::<wbr><a class='mod' href=''>error</a></span><span class='out-of-band'><span id='render-detail'>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>ceph_rust</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'>&#x2212;</span>]
</a>
</span><a id='src-88' class='srclink' href='../../src/ceph_rust/src/error.rs.html#15-109' title='goto source code'>[src]</a></span></h1>
</span><a class='srclink' href='../../src/ceph_rust/error.rs.html#15-111' title='goto source code'>[src]</a></span></h1>
<h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table>
<tr class=' module-item'>
<td><a class='enum' href='enum.RadosError.html'
title='ceph_rust::error::RadosError'>RadosError</a></td>
<td><a class="enum" href="enum.RadosError.html"
title='enum ceph_rust::error::RadosError'>RadosError</a></td>
<td class='docblock-short'>
<p>Custom error handling for the library</p>
</td>
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="type" href="type.RadosResult.html"
title='type ceph_rust::error::RadosResult'>RadosResult</a></td>
<td class='docblock-short'>

</td>
</tr></table></section>
<section id='search' class="content hidden"></section>

Expand Down Expand Up @@ -113,7 +122,6 @@ <h2>Search Tricks</h2>
window.rootPath = "../../";
window.currentCrate = "ceph_rust";
</script>
<script src="../../jquery.js"></script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/ceph_rust/error/sidebar-items.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

112 changes: 112 additions & 0 deletions docs/ceph_rust/error/type.RadosResult.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
<!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 `RadosResult` type in crate `ceph_rust`.">
<meta name="keywords" content="rust, rustlang, rust-lang, RadosResult">

<title>ceph_rust::error::RadosResult - Rust</title>

<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">


<link rel="shortcut icon" href="https://lambdastackio.github.io/static/images/favicon.ico">

</head>
<body class="rustdoc type">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->



<nav class="sidebar">
<a href='../../ceph_rust/index.html'><img src='https://lambdastackio.github.io/static/images/lambdastack-200x200.png' alt='logo' width='100'></a>
<p class='location'><a href='../index.html'>ceph_rust</a>::<wbr><a href='index.html'>error</a></p><script>window.sidebarCurrent = {name: 'RadosResult', ty: 'type', 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">
<h1 class='fqn'><span class='in-band'>Type Definition <a href='../index.html'>ceph_rust</a>::<wbr><a href='index.html'>error</a>::<wbr><a class="type" href=''>RadosResult</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 class='srclink' href='../../src/ceph_rust/error.rs.html#34' title='goto source code'>[src]</a></span></h1>
<pre class='rust typedef'>type RadosResult&lt;T&gt; = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, <a class="enum" href="../../ceph_rust/error/enum.RadosError.html" title="enum ceph_rust::error::RadosError">RadosError</a>&gt;;</pre></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 = "ceph_rust";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>
40 changes: 20 additions & 20 deletions docs/ceph_rust/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,15 @@

<title>ceph_rust - Rust</title>

<link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../main.css">


<link rel="shortcut icon" href="https://lambdastackio.github.io/static/images/favicon.ico">

</head>
<body class="rustdoc">
<body class="rustdoc mod">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
Expand All @@ -28,7 +29,7 @@

<nav class="sidebar">
<a href='../ceph_rust/index.html'><img src='https://lambdastackio.github.io/static/images/lambdastack-200x200.png' alt='logo' width='100'></a>
<p class='location'></p><script>window.sidebarCurrent = {name: 'ceph_rust', ty: 'mod', relpath: '../'};</script>
<p class='location'>Crate ceph_rust</p><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'ceph_rust', ty: 'mod', relpath: '../'};</script>
</nav>

<nav class="sub">
Expand All @@ -42,12 +43,12 @@
</form>
</nav>

<section id='main' class="content mod">
<h1 class='fqn'><span class='in-band'>Crate <a class='mod' href=''>ceph_rust</a></span><span class='out-of-band'><span id='render-detail'>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Crate <a class="mod" href=''>ceph_rust</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-0' class='srclink' href='../src/ceph_rust/src/lib.rs.html#16-65' title='goto source code'>[src]</a></span></h1>
</span><a class='srclink' href='../src/ceph_rust/lib.rs.html#16-65' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Ceph-rust is a thin layer over the librados C interface. A little higher abstraction layer will
be coming next that will encapsulate all of the &quot;C&quot; specific features so that only pure Rust will be needed.</p>

Expand Down Expand Up @@ -77,51 +78,51 @@ <h1 class='fqn'><span class='in-band'>Crate <a class='mod' href=''>ceph_rust</a>
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table>
<tr class=' module-item'>
<td><a class='mod' href='error/index.html'
title='ceph_rust::error'>error</a></td>
<td><a class="mod" href="error/index.html"
title='mod ceph_rust::error'>error</a></td>
<td class='docblock-short'>

</td>
</tr>
<tr class=' module-item'>
<td><a class='mod' href='json/index.html'
title='ceph_rust::json'>json</a></td>
<td><a class="mod" href="json/index.html"
title='mod ceph_rust::json'>json</a></td>
<td class='docblock-short'>

</td>
</tr>
<tr class=' module-item'>
<td><a class='mod' href='rados/index.html'
title='ceph_rust::rados'>rados</a></td>
<td><a class="mod" href="rados/index.html"
title='mod ceph_rust::rados'>rados</a></td>
<td class='docblock-short'>

</td>
</tr>
<tr class=' module-item'>
<td><a class='mod' href='status/index.html'
title='ceph_rust::status'>status</a></td>
<td><a class="mod" href="status/index.html"
title='mod ceph_rust::status'>status</a></td>
<td class='docblock-short'>

</td>
</tr>
<tr class=' module-item'>
<td><a class='mod' href='utils/index.html'
title='ceph_rust::utils'>utils</a></td>
<td><a class="mod" href="utils/index.html"
title='mod ceph_rust::utils'>utils</a></td>
<td class='docblock-short'>

</td>
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
<table>
<tr class=' module-item'>
<td><a class='type' href='type.JsonData.html'
title='ceph_rust::JsonData'>JsonData</a></td>
<td><a class="type" href="type.JsonData.html"
title='type ceph_rust::JsonData'>JsonData</a></td>
<td class='docblock-short'>

</td>
</tr>
<tr class=' module-item'>
<td><a class='type' href='type.JsonValue.html'
title='ceph_rust::JsonValue'>JsonValue</a></td>
<td><a class="type" href="type.JsonValue.html"
title='type ceph_rust::JsonValue'>JsonValue</a></td>
<td class='docblock-short'>

</td>
Expand Down Expand Up @@ -182,7 +183,6 @@ <h2>Search Tricks</h2>
window.rootPath = "../";
window.currentCrate = "ceph_rust";
</script>
<script src="../jquery.js"></script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
Expand Down
12 changes: 6 additions & 6 deletions docs/ceph_rust/json/fn.json_as_string.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,15 @@

<title>ceph_rust::json::json_as_string - Rust</title>

<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">


<link rel="shortcut icon" href="https://lambdastackio.github.io/static/images/favicon.ico">

</head>
<body class="rustdoc">
<body class="rustdoc fn">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
Expand All @@ -42,13 +43,13 @@
</form>
</nav>

<section id='main' class="content fn">
<h1 class='fqn'><span class='in-band'>Function <a href='../index.html'>ceph_rust</a>::<wbr><a href='index.html'>json</a>::<wbr><a class='fn' href=''>json_as_string</a></span><span class='out-of-band'><span id='render-detail'>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Function <a href='../index.html'>ceph_rust</a>::<wbr><a href='index.html'>json</a>::<wbr><a class="fn" href=''>json_as_string</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-86' class='srclink' href='../../src/ceph_rust/src/json.rs.html#44-46' title='goto source code'>[src]</a></span></h1>
<pre class='rust fn'>pub fn json_as_string(json_data: &amp;<a class='type' href='../../ceph_rust/type.JsonData.html' title='ceph_rust::JsonData'>JsonData</a>) -&gt; <a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a></pre><div class='docblock'><p>More specific String cast of an individual JsonData object.</p>
</span><a class='srclink' href='../../src/ceph_rust/json.rs.html#44-46' title='goto source code'>[src]</a></span></h1>
<pre class='rust fn'>pub fn json_as_string(json_data: &amp;<a class="type" href="../../ceph_rust/type.JsonData.html" title="type ceph_rust::JsonData">JsonData</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::string::String">String</a></pre><div class='docblock'><p>More specific String cast of an individual JsonData object.</p>
</div></section>
<section id='search' class="content hidden"></section>

Expand Down Expand Up @@ -106,7 +107,6 @@ <h2>Search Tricks</h2>
window.rootPath = "../../";
window.currentCrate = "ceph_rust";
</script>
<script src="../../jquery.js"></script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
Expand Down
Loading

0 comments on commit ead7751

Please sign in to comment.