Skip to content

Commit ead7751

Browse files
author
Chris Jones
committed
Updated the docs from the latest PR
1 parent 24cfe8d commit ead7751

File tree

112 files changed

+4748
-1604
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

112 files changed

+4748
-1604
lines changed

‎docs/COPYRIGHT.txt‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,6 @@ included, and carry their own copyright notices and license terms:
2727
Licensed under the SIL Open Font License, Version 1.1.
2828
See Heuristica-LICENSE.txt.
2929

30-
* jQuery (jquery-2.1.4.min.js):
31-
32-
Copyright 2005, 2015 jQuery Foundation, Inc.
33-
Licensed under the MIT license (see LICENSE-MIT.txt).
34-
3530
* rustdoc.css, main.js, and playpen.js:
3631

3732
Copyright 2015 The Rust Developers.

‎docs/ceph_rust/error/RadosResult.t.html‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta http-equiv="refresh" content="0;URL=type.RadosResult.html">
5+
</head>
6+
<body>
7+
<p>Redirecting to <a href="type.RadosResult.html">type.RadosResult.html</a>...</p>
8+
<script>location.replace("type.RadosResult.html" + location.search + location.hash);</script>
9+
</body>
10+
</html>

‎docs/ceph_rust/error/enum.RadosError.html‎

Lines changed: 34 additions & 34 deletions
Large diffs are not rendered by default.

‎docs/ceph_rust/error/index.html‎

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,15 @@
99

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

12+
<link rel="stylesheet" type="text/css" href="../../normalize.css">
1213
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
1314
<link rel="stylesheet" type="text/css" href="../../main.css">
1415

1516

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

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

2930
<nav class="sidebar">
3031
<a href='../../ceph_rust/index.html'><img src='https://lambdastackio.github.io/static/images/lambdastack-200x200.png' alt='logo' width='100'></a>
31-
<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>
32+
<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>
3233
</nav>
3334

3435
<nav class="sub">
@@ -42,20 +43,28 @@
4243
</form>
4344
</nav>
4445

45-
<section id='main' class="content mod">
46-
<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'>
46+
<section id='main' class="content">
47+
<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'>
4748
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
4849
[<span class='inner'>&#x2212;</span>]
4950
</a>
50-
</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>
51+
</span><a class='srclink' href='../../src/ceph_rust/error.rs.html#15-111' title='goto source code'>[src]</a></span></h1>
5152
<h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
5253
<table>
5354
<tr class=' module-item'>
54-
<td><a class='enum' href='enum.RadosError.html'
55-
title='ceph_rust::error::RadosError'>RadosError</a></td>
55+
<td><a class="enum" href="enum.RadosError.html"
56+
title='enum ceph_rust::error::RadosError'>RadosError</a></td>
5657
<td class='docblock-short'>
5758
<p>Custom error handling for the library</p>
5859
</td>
60+
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
61+
<table>
62+
<tr class=' module-item'>
63+
<td><a class="type" href="type.RadosResult.html"
64+
title='type ceph_rust::error::RadosResult'>RadosResult</a></td>
65+
<td class='docblock-short'>
66+
67+
</td>
5968
</tr></table></section>
6069
<section id='search' class="content hidden"></section>
6170

@@ -113,7 +122,6 @@ <h2>Search Tricks</h2>
113122
window.rootPath = "../../";
114123
window.currentCrate = "ceph_rust";
115124
</script>
116-
<script src="../../jquery.js"></script>
117125
<script src="../../main.js"></script>
118126
<script defer src="../../search-index.js"></script>
119127
</body>

‎docs/ceph_rust/error/sidebar-items.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/ceph_rust/error/type.RadosResult.html‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<meta name="generator" content="rustdoc">
7+
<meta name="description" content="API documentation for the Rust `RadosResult` type in crate `ceph_rust`.">
8+
<meta name="keywords" content="rust, rustlang, rust-lang, RadosResult">
9+
10+
<title>ceph_rust::error::RadosResult - Rust</title>
11+
12+
<link rel="stylesheet" type="text/css" href="../../normalize.css">
13+
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
14+
<link rel="stylesheet" type="text/css" href="../../main.css">
15+
16+
17+
<link rel="shortcut icon" href="https://lambdastackio.github.io/static/images/favicon.ico">
18+
19+
</head>
20+
<body class="rustdoc type">
21+
<!--[if lte IE 8]>
22+
<div class="warning">
23+
This old browser is unsupported and will most likely display funky
24+
things.
25+
</div>
26+
<![endif]-->
27+
28+
29+
30+
<nav class="sidebar">
31+
<a href='../../ceph_rust/index.html'><img src='https://lambdastackio.github.io/static/images/lambdastack-200x200.png' alt='logo' width='100'></a>
32+
<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>
33+
</nav>
34+
35+
<nav class="sub">
36+
<form class="search-form js-only">
37+
<div class="search-container">
38+
<input class="search-input" name="search"
39+
autocomplete="off"
40+
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
41+
type="search">
42+
</div>
43+
</form>
44+
</nav>
45+
46+
<section id='main' class="content">
47+
<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'>
48+
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
49+
[<span class='inner'>&#x2212;</span>]
50+
</a>
51+
</span><a class='srclink' href='../../src/ceph_rust/error.rs.html#34' title='goto source code'>[src]</a></span></h1>
52+
<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>
53+
<section id='search' class="content hidden"></section>
54+
55+
<section class="footer"></section>
56+
57+
<aside id="help" class="hidden">
58+
<div>
59+
<h1 class="hidden">Help</h1>
60+
61+
<div class="shortcuts">
62+
<h2>Keyboard Shortcuts</h2>
63+
64+
<dl>
65+
<dt>?</dt>
66+
<dd>Show this help dialog</dd>
67+
<dt>S</dt>
68+
<dd>Focus the search field</dd>
69+
<dt>&larrb;</dt>
70+
<dd>Move up in search results</dd>
71+
<dt>&rarrb;</dt>
72+
<dd>Move down in search results</dd>
73+
<dt>&#9166;</dt>
74+
<dd>Go to active search result</dd>
75+
<dt>+</dt>
76+
<dd>Collapse/expand all sections</dd>
77+
</dl>
78+
</div>
79+
80+
<div class="infos">
81+
<h2>Search Tricks</h2>
82+
83+
<p>
84+
Prefix searches with a type followed by a colon (e.g.
85+
<code>fn:</code>) to restrict the search to a given type.
86+
</p>
87+
88+
<p>
89+
Accepted types are: <code>fn</code>, <code>mod</code>,
90+
<code>struct</code>, <code>enum</code>,
91+
<code>trait</code>, <code>type</code>, <code>macro</code>,
92+
and <code>const</code>.
93+
</p>
94+
95+
<p>
96+
Search functions by type signature (e.g.
97+
<code>vec -> usize</code> or <code>* -> vec</code>)
98+
</p>
99+
</div>
100+
</div>
101+
</aside>
102+
103+
104+
105+
<script>
106+
window.rootPath = "../../";
107+
window.currentCrate = "ceph_rust";
108+
</script>
109+
<script src="../../main.js"></script>
110+
<script defer src="../../search-index.js"></script>
111+
</body>
112+
</html>

‎docs/ceph_rust/index.html‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,15 @@
99

1010
<title>ceph_rust - Rust</title>
1111

12+
<link rel="stylesheet" type="text/css" href="../normalize.css">
1213
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
1314
<link rel="stylesheet" type="text/css" href="../main.css">
1415

1516

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

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

2930
<nav class="sidebar">
3031
<a href='../ceph_rust/index.html'><img src='https://lambdastackio.github.io/static/images/lambdastack-200x200.png' alt='logo' width='100'></a>
31-
<p class='location'></p><script>window.sidebarCurrent = {name: 'ceph_rust', ty: 'mod', relpath: '../'};</script>
32+
<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>
3233
</nav>
3334

3435
<nav class="sub">
@@ -42,12 +43,12 @@
4243
</form>
4344
</nav>
4445

45-
<section id='main' class="content mod">
46-
<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'>
46+
<section id='main' class="content">
47+
<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'>
4748
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
4849
[<span class='inner'>&#x2212;</span>]
4950
</a>
50-
</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>
51+
</span><a class='srclink' href='../src/ceph_rust/lib.rs.html#16-65' title='goto source code'>[src]</a></span></h1>
5152
<div class='docblock'><p>Ceph-rust is a thin layer over the librados C interface. A little higher abstraction layer will
5253
be coming next that will encapsulate all of the &quot;C&quot; specific features so that only pure Rust will be needed.</p>
5354

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

8485
</td>
8586
</tr>
8687
<tr class=' module-item'>
87-
<td><a class='mod' href='json/index.html'
88-
title='ceph_rust::json'>json</a></td>
88+
<td><a class="mod" href="json/index.html"
89+
title='mod ceph_rust::json'>json</a></td>
8990
<td class='docblock-short'>
9091

9192
</td>
9293
</tr>
9394
<tr class=' module-item'>
94-
<td><a class='mod' href='rados/index.html'
95-
title='ceph_rust::rados'>rados</a></td>
95+
<td><a class="mod" href="rados/index.html"
96+
title='mod ceph_rust::rados'>rados</a></td>
9697
<td class='docblock-short'>
9798

9899
</td>
99100
</tr>
100101
<tr class=' module-item'>
101-
<td><a class='mod' href='status/index.html'
102-
title='ceph_rust::status'>status</a></td>
102+
<td><a class="mod" href="status/index.html"
103+
title='mod ceph_rust::status'>status</a></td>
103104
<td class='docblock-short'>
104105

105106
</td>
106107
</tr>
107108
<tr class=' module-item'>
108-
<td><a class='mod' href='utils/index.html'
109-
title='ceph_rust::utils'>utils</a></td>
109+
<td><a class="mod" href="utils/index.html"
110+
title='mod ceph_rust::utils'>utils</a></td>
110111
<td class='docblock-short'>
111112

112113
</td>
113114
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
114115
<table>
115116
<tr class=' module-item'>
116-
<td><a class='type' href='type.JsonData.html'
117-
title='ceph_rust::JsonData'>JsonData</a></td>
117+
<td><a class="type" href="type.JsonData.html"
118+
title='type ceph_rust::JsonData'>JsonData</a></td>
118119
<td class='docblock-short'>
119120

120121
</td>
121122
</tr>
122123
<tr class=' module-item'>
123-
<td><a class='type' href='type.JsonValue.html'
124-
title='ceph_rust::JsonValue'>JsonValue</a></td>
124+
<td><a class="type" href="type.JsonValue.html"
125+
title='type ceph_rust::JsonValue'>JsonValue</a></td>
125126
<td class='docblock-short'>
126127

127128
</td>
@@ -182,7 +183,6 @@ <h2>Search Tricks</h2>
182183
window.rootPath = "../";
183184
window.currentCrate = "ceph_rust";
184185
</script>
185-
<script src="../jquery.js"></script>
186186
<script src="../main.js"></script>
187187
<script defer src="../search-index.js"></script>
188188
</body>

‎docs/ceph_rust/json/fn.json_as_string.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,15 @@
99

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

12+
<link rel="stylesheet" type="text/css" href="../../normalize.css">
1213
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
1314
<link rel="stylesheet" type="text/css" href="../../main.css">
1415

1516

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

1819
</head>
19-
<body class="rustdoc">
20+
<body class="rustdoc fn">
2021
<!--[if lte IE 8]>
2122
<div class="warning">
2223
This old browser is unsupported and will most likely display funky
@@ -42,13 +43,13 @@
4243
</form>
4344
</nav>
4445

45-
<section id='main' class="content fn">
46-
<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'>
46+
<section id='main' class="content">
47+
<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'>
4748
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
4849
[<span class='inner'>&#x2212;</span>]
4950
</a>
50-
</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>
51-
<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>
51+
</span><a class='srclink' href='../../src/ceph_rust/json.rs.html#44-46' title='goto source code'>[src]</a></span></h1>
52+
<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>
5253
</div></section>
5354
<section id='search' class="content hidden"></section>
5455

@@ -106,7 +107,6 @@ <h2>Search Tricks</h2>
106107
window.rootPath = "../../";
107108
window.currentCrate = "ceph_rust";
108109
</script>
109-
<script src="../../jquery.js"></script>
110110
<script src="../../main.js"></script>
111111
<script defer src="../../search-index.js"></script>
112112
</body>

0 commit comments

Comments
 (0)