<!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 `/home/hasufell/.cargo/registry/src/github.com-1ecc6299db9ec823/alsa-0.1.8/src/error.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>error.rs.html -- source</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">
</head>
<body class="rustdoc source">
<!--[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"><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>
</pre><pre class="rust ">
<span class="attribute">#<span class="op">!</span>[<span class="ident">macro_use</span>]</span>
<span class="kw">use</span> <span class="ident">libc</span>::{<span class="ident">c_void</span>, <span class="ident">c_int</span>, <span class="ident">c_char</span>, <span class="ident">free</span>};
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ptr</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">borrow</span>::<span class="ident">Cow</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fmt</span>;
<span class="kw">use</span> <span class="ident">alsa</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ffi</span>::<span class="ident">CStr</span>;
<span class="kw">const</span> <span class="ident">INVALID_STRING</span>: <span class="ident">c_int</span> <span class="op">=</span> <span class="number">1</span>;
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">INVALID_FORMAT</span>: <span class="ident">c_int</span> <span class="op">=</span> <span class="number">2</span>;
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">INVALID_ENUM</span>: <span class="ident">c_int</span> <span class="op">=</span> <span class="number">3</span>;
<span class="doccomment">/// Most ALSA functions can return a negative error code.</span>
<span class="doccomment">/// If so, then that error code is wrapped into this `Error` struct.</span>
<span class="doccomment">/// An Error is also returned in case ALSA returns a string that</span>
<span class="doccomment">/// cannot be translated into Rust's UTF-8 strings.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Error</span>(<span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">>></span>, <span class="ident">c_int</span>);
<span class="kw">pub</span> <span class="kw">type</span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="op">=</span> ::<span class="ident">std</span>::<span class="ident">result</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">Error</span><span class="op">></span>;
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">acheck</span> {
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">f</span>: <span class="ident">ident</span> ( $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">x</span>: <span class="ident">expr</span>),<span class="op">*</span> ) ) <span class="op">=></span> {{
<span class="kw">let</span> <span class="ident">r</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">alsa</span>::<span class="macro-nonterminal">$</span><span class="macro-nonterminal">f</span>( $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">x</span>),<span class="op">*</span> ) };
<span class="kw">if</span> <span class="ident">r</span> <span class="op"><</span> <span class="number">0</span> { <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">new</span>(<span class="prelude-val">Some</span>(<span class="macro">stringify</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">f</span>).<span class="ident">into</span>()), <span class="ident">r</span> <span class="kw">as</span> ::<span class="ident">libc</span>::<span class="ident">c_int</span>)) }
<span class="kw">else</span> { <span class="prelude-val">Ok</span>(<span class="ident">r</span>) }
}}
}
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">from_const</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span>(<span class="ident">func</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>, <span class="ident">s</span>: <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">c_char</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span><span class="op">></span> {
<span class="kw">if</span> <span class="ident">s</span> <span class="op">==</span> <span class="ident">ptr</span>::<span class="ident">null</span>() { <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">invalid_str</span>(<span class="ident">func</span>)) };
<span class="kw">let</span> <span class="ident">cc</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">CStr</span>::<span class="ident">from_ptr</span>(<span class="ident">s</span>) };
::<span class="ident">std</span>::<span class="ident">str</span>::<span class="ident">from_utf8</span>(<span class="ident">cc</span>.<span class="ident">to_bytes</span>()).<span class="ident">map_err</span>(<span class="op">|</span>_<span class="op">|</span> <span class="ident">Error</span>::<span class="ident">invalid_str</span>(<span class="ident">func</span>))
}
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">from_alloc</span>(<span class="ident">func</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>, <span class="ident">s</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">c_char</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> {
<span class="kw">if</span> <span class="ident">s</span> <span class="op">==</span> <span class="ident">ptr</span>::<span class="ident">null_mut</span>() { <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">invalid_str</span>(<span class="ident">func</span>)) };
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">CStr</span>::<span class="ident">from_ptr</span>(<span class="ident">s</span>) };
<span class="kw">let</span> <span class="ident">ss</span> <span class="op">=</span> <span class="macro">try</span><span class="macro">!</span>(::<span class="ident">std</span>::<span class="ident">str</span>::<span class="ident">from_utf8</span>(<span class="ident">c</span>.<span class="ident">to_bytes</span>()).<span class="ident">map_err</span>(<span class="op">|</span>_<span class="op">|</span> {
<span class="kw">unsafe</span> { <span class="ident">free</span>(<span class="ident">s</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">c_void</span>); }
<span class="ident">Error</span>::<span class="ident">invalid_str</span>(<span class="ident">func</span>)
})).<span class="ident">to_string</span>();
<span class="kw">unsafe</span> { <span class="ident">free</span>(<span class="ident">s</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">c_void</span>); }
<span class="prelude-val">Ok</span>(<span class="ident">ss</span>)
}
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">from_code</span>(<span class="ident">func</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>, <span class="ident">r</span>: <span class="ident">c_int</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">c_int</span><span class="op">></span> {
<span class="kw">if</span> <span class="ident">r</span> <span class="op"><</span> <span class="number">0</span> { <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">new</span>(<span class="prelude-val">Some</span>(<span class="ident">func</span>.<span class="ident">into</span>()), <span class="ident">r</span>)) }
<span class="kw">else</span> { <span class="prelude-val">Ok</span>(<span class="ident">r</span>) }
}
<span class="kw">impl</span> <span class="ident">Error</span> {
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">func</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">>></span>, <span class="ident">res</span>: <span class="ident">c_int</span>) <span class="op">-></span> <span class="ident">Error</span> { <span class="ident">Error</span>(<span class="ident">func</span>, <span class="ident">res</span>) }
<span class="kw">fn</span> <span class="ident">invalid_str</span>(<span class="ident">func</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>) <span class="op">-></span> <span class="ident">Error</span> { <span class="ident">Error</span>(<span class="prelude-val">Some</span>(<span class="ident">func</span>.<span class="ident">into</span>()), <span class="ident">INVALID_STRING</span>) }
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">code</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">c_int</span> { <span class="self">self</span>.<span class="number">1</span> }
}
<span class="kw">impl</span> ::<span class="ident">std</span>::<span class="ident">error</span>::<span class="ident">Error</span> <span class="kw">for</span> <span class="ident">Error</span> {
<span class="kw">fn</span> <span class="ident">description</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">str</span> { <span class="string">"ALSA error"</span> }
}
<span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">Error</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="kw">let</span> <span class="ident">cc</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">CStr</span>::<span class="ident">from_ptr</span>(<span class="ident">alsa</span>::<span class="ident">snd_strerror</span>(<span class="self">self</span>.<span class="number">1</span>)) };
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> ::<span class="ident">std</span>::<span class="ident">str</span>::<span class="ident">from_utf8</span>(<span class="ident">cc</span>.<span class="ident">to_bytes</span>()).<span class="ident">unwrap_or_else</span>(<span class="op">|</span>_<span class="op">|</span> <span class="string">"(invalid UTF8)"</span>);
<span class="kw">match</span> <span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span> {
<span class="kw-2">&</span><span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">s</span>) <span class="op">=></span> <span class="macro">write</span><span class="macro">!</span>(<span class="ident">f</span>, <span class="string">"ALSA error: '{}' (code {}) from function '{}'"</span>, <span class="ident">c</span>, <span class="self">self</span>.<span class="number">1</span>, <span class="ident">s</span>),
<span class="kw-2">&</span><span class="prelude-val">None</span> <span class="op">=></span> <span class="macro">write</span><span class="macro">!</span>(<span class="ident">f</span>, <span class="string">"ALSA error: '{}' (code {})"</span>, <span class="ident">c</span>, <span class="self">self</span>.<span class="number">1</span>),
}
}
}
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">Error</span><span class="op">></span> <span class="kw">for</span> <span class="ident">fmt</span>::<span class="ident">Error</span> {
<span class="kw">fn</span> <span class="ident">from</span>(_: <span class="ident">Error</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="ident">Error</span> { <span class="ident">fmt</span>::<span class="ident">Error</span> }
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">broken_pcm_name</span>() {
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ffi</span>::<span class="ident">CString</span>;
<span class="kw">let</span> <span class="ident">e</span> <span class="op">=</span> ::<span class="ident">PCM</span>::<span class="ident">open</span>(<span class="kw-2">&</span><span class="kw-2">*</span><span class="ident">CString</span>::<span class="ident">new</span>(<span class="string">"this_PCM_does_not_exist"</span>).<span class="ident">unwrap</span>(), ::<span class="ident">Direction</span>::<span class="ident">Playback</span>, <span class="bool-val">false</span>).<span class="ident">err</span>().<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">e</span>.<span class="number">0</span>, <span class="prelude-val">Some</span>(<span class="string">"snd_pcm_open"</span>.<span class="ident">into</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>⇤</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>
<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 = "alsa";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>