ceph-rust 0.1.14

Official Ceph-rust. A rust-lang specific interface to Ceph librados and Admin Sockets. You can create a Ceph development environment with the Chef automation tools: https://github.com/bloomberg/chef-bcs or with ceph-ansible. Chef-bcs uses the ceph-chef cookbook created and manage at github.com/ceph/ceph-chef. It will build out a full Ceph environment which you can then use for development etc. See README.md for details.
<!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="Source to the Rust file `examples/ceph.rs`.">
    <meta name="keywords" content="rust, rustlang, rust-lang">

    <title>ceph.rs.html -- source</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">
        
        
    </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 source"><pre class="line-numbers"><span id="1">  1</span>
<span id="2">  2</span>
<span id="3">  3</span>
<span id="4">  4</span>
<span id="5">  5</span>
<span id="6">  6</span>
<span id="7">  7</span>
<span id="8">  8</span>
<span id="9">  9</span>
<span id="10"> 10</span>
<span id="11"> 11</span>
<span id="12"> 12</span>
<span id="13"> 13</span>
<span id="14"> 14</span>
<span id="15"> 15</span>
<span id="16"> 16</span>
<span id="17"> 17</span>
<span id="18"> 18</span>
<span id="19"> 19</span>
<span id="20"> 20</span>
<span id="21"> 21</span>
<span id="22"> 22</span>
<span id="23"> 23</span>
<span id="24"> 24</span>
<span id="25"> 25</span>
<span id="26"> 26</span>
<span id="27"> 27</span>
<span id="28"> 28</span>
<span id="29"> 29</span>
<span id="30"> 30</span>
<span id="31"> 31</span>
<span id="32"> 32</span>
<span id="33"> 33</span>
<span id="34"> 34</span>
<span id="35"> 35</span>
<span id="36"> 36</span>
<span id="37"> 37</span>
<span id="38"> 38</span>
<span id="39"> 39</span>
<span id="40"> 40</span>
<span id="41"> 41</span>
<span id="42"> 42</span>
<span id="43"> 43</span>
<span id="44"> 44</span>
<span id="45"> 45</span>
<span id="46"> 46</span>
<span id="47"> 47</span>
<span id="48"> 48</span>
<span id="49"> 49</span>
<span id="50"> 50</span>
<span id="51"> 51</span>
<span id="52"> 52</span>
<span id="53"> 53</span>
<span id="54"> 54</span>
<span id="55"> 55</span>
<span id="56"> 56</span>
<span id="57"> 57</span>
<span id="58"> 58</span>
<span id="59"> 59</span>
<span id="60"> 60</span>
<span id="61"> 61</span>
<span id="62"> 62</span>
<span id="63"> 63</span>
<span id="64"> 64</span>
<span id="65"> 65</span>
<span id="66"> 66</span>
<span id="67"> 67</span>
<span id="68"> 68</span>
<span id="69"> 69</span>
<span id="70"> 70</span>
<span id="71"> 71</span>
<span id="72"> 72</span>
<span id="73"> 73</span>
<span id="74"> 74</span>
<span id="75"> 75</span>
<span id="76"> 76</span>
<span id="77"> 77</span>
<span id="78"> 78</span>
<span id="79"> 79</span>
<span id="80"> 80</span>
<span id="81"> 81</span>
<span id="82"> 82</span>
<span id="83"> 83</span>
<span id="84"> 84</span>
<span id="85"> 85</span>
<span id="86"> 86</span>
<span id="87"> 87</span>
<span id="88"> 88</span>
<span id="89"> 89</span>
<span id="90"> 90</span>
<span id="91"> 91</span>
<span id="92"> 92</span>
<span id="93"> 93</span>
<span id="94"> 94</span>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
</pre><pre class='rust '>
<span class='comment'>// Copyright 2017 LambdaStack All rights reserved.</span>
<span class='comment'>//</span>
<span class='comment'>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
<span class='comment'>// you may not use this file except in compliance with the License.</span>
<span class='comment'>// You may obtain a copy of the License at</span>
<span class='comment'>//</span>
<span class='comment'>// http://www.apache.org/licenses/LICENSE-2.0</span>
<span class='comment'>//</span>
<span class='comment'>// Unless required by applicable law or agreed to in writing, software</span>
<span class='comment'>// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<span class='comment'>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class='comment'>// See the License for the specific language governing permissions and</span>
<span class='comment'>// limitations under the License.</span>

<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>allow</span>(<span class='ident'>unused_imports</span>)]</span>

<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>ceph_rust</span>;
<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>libc</span>;

<span class='kw'>use</span> <span class='ident'>libc</span>::<span class='op'>*</span>;
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>ffi</span>::{<span class='ident'>CStr</span>, <span class='ident'>CString</span>};
<span class='kw'>use</span> <span class='ident'>std</span>::{<span class='ident'>ptr</span>, <span class='ident'>str</span>};

<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>target_os</span> <span class='op'>=</span> <span class='string'>&quot;linux&quot;</span>)]</span>
<span class='kw'>use</span> <span class='ident'>ceph_rust</span>::<span class='ident'>ceph</span> <span class='kw'>as</span> <span class='ident'>ceph_helpers</span>;
<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>target_os</span> <span class='op'>=</span> <span class='string'>&quot;linux&quot;</span>)]</span>
<span class='kw'>use</span> <span class='ident'>ceph_rust</span>::<span class='ident'>rados</span> <span class='kw'>as</span> <span class='ident'>ceph</span>;

<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>zeroed_c_char_buf</span> {
	(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>n</span>:<span class='ident'>expr</span>) <span class='op'>=&gt;</span> {
		<span class='ident'>repeat</span>(<span class='number'>0</span>).<span class='ident'>take</span>(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>n</span>).<span class='ident'>collect</span>::<span class='op'>&lt;</span><span class='ident'>Vec</span><span class='op'>&lt;</span><span class='ident'>c_char</span><span class='op'>&gt;&gt;</span>();
	}
}

<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>not</span>(<span class='ident'>target_os</span> <span class='op'>=</span> <span class='string'>&quot;linux&quot;</span>))]</span>
<span class='kw'>fn</span> <span class='ident'>main</span>() {}

<span class='comment'>// NB: The examples below show a mix of raw native access and rust specific calls.</span>

<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>target_os</span> <span class='op'>=</span> <span class='string'>&quot;linux&quot;</span>)]</span>
<span class='kw'>fn</span> <span class='ident'>main</span>() {
    <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>major</span>: <span class='ident'>i32</span> <span class='op'>=</span> <span class='number'>0</span>;
    <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>minor</span>: <span class='ident'>i32</span> <span class='op'>=</span> <span class='number'>0</span>;
    <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>extra</span>: <span class='ident'>i32</span> <span class='op'>=</span> <span class='number'>0</span>;

    <span class='kw'>let</span> <span class='ident'>config_file</span> <span class='op'>=</span> <span class='ident'>CString</span>::<span class='ident'>new</span>(<span class='string'>&quot;/etc/ceph/ceph.conf&quot;</span>).<span class='ident'>unwrap</span>();
    <span class='kw'>let</span> <span class='ident'>pool_name</span> <span class='op'>=</span> <span class='ident'>CString</span>::<span class='ident'>new</span>(<span class='string'>&quot;lsio&quot;</span>).<span class='ident'>unwrap</span>();
    <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>cluster</span>: <span class='ident'>ceph</span>::<span class='ident'>rados_t</span> <span class='op'>=</span> <span class='ident'>std</span>::<span class='ident'>ptr</span>::<span class='ident'>null_mut</span>();
    <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>ret_code</span>: <span class='ident'>i32</span>;

    <span class='comment'>// NB: These examples (except for a few) are low level examples that require the unsafe block.</span>
    <span class='comment'>// However, work for the higher level pur Rust is being worked on in the ceph.rs module of</span>
    <span class='comment'>// the library. A few of those are present below. We will create a common Result or Option</span>
    <span class='comment'>// return and allow for pattern matching.</span>

    <span class='kw'>unsafe</span> {
        <span class='ident'>ceph</span>::<span class='ident'>rados_version</span>(<span class='kw-2'>&amp;</span><span class='kw-2'>mut</span> <span class='ident'>major</span>, <span class='kw-2'>&amp;</span><span class='kw-2'>mut</span> <span class='ident'>minor</span>, <span class='kw-2'>&amp;</span><span class='kw-2'>mut</span> <span class='ident'>extra</span>);
        <span class='ident'>ret_code</span> <span class='op'>=</span> <span class='ident'>ceph</span>::<span class='ident'>rados_create</span>(<span class='kw-2'>&amp;</span><span class='kw-2'>mut</span> <span class='ident'>cluster</span>, <span class='ident'>std</span>::<span class='ident'>ptr</span>::<span class='ident'>null</span>());
        <span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>&quot;Return code: {} - {:?}&quot;</span>, <span class='ident'>ret_code</span>, <span class='ident'>cluster</span>);

        <span class='ident'>ret_code</span> <span class='op'>=</span> <span class='ident'>ceph</span>::<span class='ident'>rados_conf_read_file</span>(<span class='ident'>cluster</span>, <span class='ident'>config_file</span>.<span class='ident'>as_ptr</span>());
        <span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>&quot;Return code: {} - {:?}&quot;</span>, <span class='ident'>ret_code</span>, <span class='ident'>cluster</span>);

        <span class='ident'>ret_code</span> <span class='op'>=</span> <span class='ident'>ceph</span>::<span class='ident'>rados_connect</span>(<span class='ident'>cluster</span>);
        <span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>&quot;Return code: {} - {:?}&quot;</span>, <span class='ident'>ret_code</span>, <span class='ident'>cluster</span>);

        <span class='ident'>ret_code</span> <span class='op'>=</span> <span class='ident'>ceph</span>::<span class='ident'>rados_pool_create</span>(<span class='ident'>cluster</span>, <span class='ident'>pool_name</span>.<span class='ident'>as_ptr</span>());
        <span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>&quot;Return code: {}&quot;</span>, <span class='ident'>ret_code</span>);

        <span class='kw'>let</span> <span class='ident'>pools_list</span> <span class='op'>=</span> <span class='ident'>ceph_helpers</span>::<span class='ident'>rados_pools</span>(<span class='ident'>cluster</span>).<span class='ident'>unwrap</span>();
        <span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>&quot;{:?}&quot;</span>, <span class='ident'>pools_list</span>);

        <span class='ident'>ret_code</span> <span class='op'>=</span> <span class='ident'>ceph</span>::<span class='ident'>rados_pool_delete</span>(<span class='ident'>cluster</span>, <span class='ident'>pool_name</span>.<span class='ident'>as_ptr</span>());
        <span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>&quot;Return code: {}&quot;</span>, <span class='ident'>ret_code</span>);

        <span class='kw'>let</span> <span class='ident'>instance_id</span> <span class='op'>=</span> <span class='ident'>ceph</span>::<span class='ident'>rados_get_instance_id</span>(<span class='ident'>cluster</span>);
        <span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>&quot;Instance ID: {}&quot;</span>, <span class='ident'>instance_id</span>);

        <span class='kw'>let</span> <span class='ident'>buf_size</span>: <span class='ident'>usize</span> <span class='op'>=</span> <span class='number'>37</span>; <span class='comment'>// 36 is the constant size +1 for null.</span>
        <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>fs_id</span>: <span class='ident'>Vec</span><span class='op'>&lt;</span><span class='ident'>u8</span><span class='op'>&gt;</span> <span class='op'>=</span> <span class='ident'>Vec</span>::<span class='ident'>with_capacity</span>(<span class='ident'>buf_size</span>);

        <span class='kw'>let</span> <span class='ident'>len</span> <span class='op'>=</span> <span class='ident'>ceph</span>::<span class='ident'>rados_cluster_fsid</span>(<span class='ident'>cluster</span>, <span class='ident'>fs_id</span>.<span class='ident'>as_mut_ptr</span>() <span class='kw'>as</span> <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>i8</span>, <span class='ident'>buf_size</span>);
        <span class='kw'>let</span> <span class='ident'>slice</span> <span class='op'>=</span> <span class='ident'>slice</span>::<span class='ident'>from_raw_parts</span>(<span class='ident'>fs_id</span>.<span class='ident'>as_mut_ptr</span>(), <span class='ident'>buf_size</span> <span class='op'>-</span> <span class='number'>1</span>);
        <span class='kw'>let</span> <span class='ident'>s</span>: <span class='kw-2'>&amp;</span><span class='ident'>str</span> <span class='op'>=</span> <span class='ident'>str</span>::<span class='ident'>from_utf8</span>(<span class='ident'>slice</span>).<span class='ident'>unwrap</span>();
        <span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>&quot;rados_cluster_fsid len: {} - {}&quot;</span>, <span class='ident'>len</span>, <span class='ident'>s</span>);

        <span class='comment'>// Rust specific example...</span>
        <span class='kw'>let</span> <span class='ident'>cluster_stat</span> <span class='op'>=</span> <span class='ident'>ceph_helpers</span>::<span class='ident'>rados_stat_cluster</span>(<span class='ident'>cluster</span>);
        <span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>&quot;Cluster stat: {:?}&quot;</span>, <span class='ident'>cluster_stat</span>);

        <span class='comment'>// Mon command to check the health. Same as `ceph -s`</span>
        <span class='kw'>match</span> <span class='ident'>ceph_helpers</span>::<span class='ident'>ceph_mon_command</span>(<span class='ident'>cluster</span>, <span class='string'>&quot;{\&quot;prefix\&quot;: \&quot;status\&quot;}&quot;</span>) {
            <span class='prelude-val'>Ok</span>((<span class='ident'>outbuf</span>, <span class='ident'>outs</span>)) <span class='op'>=&gt;</span> {
                <span class='kw'>match</span> <span class='ident'>outbuf</span> {
                    <span class='prelude-val'>Some</span>(<span class='ident'>output</span>) <span class='op'>=&gt;</span> <span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>&quot;Ceph mon command (outbuf):\n{}&quot;</span>, <span class='ident'>output</span>),
                    <span class='prelude-val'>None</span> <span class='op'>=&gt;</span> {},
                }
                <span class='kw'>match</span> <span class='ident'>outs</span> {
                    <span class='prelude-val'>Some</span>(<span class='ident'>output</span>) <span class='op'>=&gt;</span> <span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>&quot;Ceph mon command (outs):\n{}&quot;</span>, <span class='ident'>output</span>),
                    <span class='prelude-val'>None</span> <span class='op'>=&gt;</span> {},
                }
            },
            <span class='prelude-val'>Err</span>(<span class='ident'>e</span>) <span class='op'>=&gt;</span> {<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>&quot;{:?}&quot;</span>, <span class='ident'>e</span>);},
        }

        <span class='comment'>// Currently - parses the `ceph --version` call. The admin socket commands `version` and `git_version`</span>
        <span class='comment'>// will be called soon to replace the string parse.</span>
        <span class='kw'>let</span> <span class='ident'>ceph_ver</span> <span class='op'>=</span> <span class='ident'>ceph_helpers</span>::<span class='ident'>ceph_version</span>();
        <span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>&quot;Ceph Version - {:?}&quot;</span>, <span class='ident'>ceph_ver</span>);

        <span class='ident'>ceph</span>::<span class='ident'>rados_shutdown</span>(<span class='ident'>cluster</span>);
    }

    <span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>&quot;RADOS Version - v{}.{}.{}&quot;</span>, <span class='ident'>major</span>, <span class='ident'>minor</span>, <span class='ident'>extra</span>);

}
</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";
    </script>
    <script src="../../../jquery.js"></script>
    <script src="../../../main.js"></script>
    <script defer src="../../../search-index.js"></script>
</body>
</html>