<!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/jule/.cargo/git/checkouts/glib-928cf7b282977403/be23d10/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>
<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>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
</pre><pre class="rust ">
<span class="comment">// Copyright 2016, The Gtk-rs Project Developers.</span>
<span class="comment">// See the COPYRIGHT file at the top-level directory of this distribution.</span>
<span class="comment">// Licensed under the MIT license, see the LICENSE file or <http://opensource.org/licenses/MIT></span>
<span class="doccomment">//! `Error` binding and helper trait.</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ffi</span>::<span class="ident">CStr</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">error</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fmt</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">str</span>;
<span class="kw">use</span> <span class="ident">translate</span>::<span class="kw-2">*</span>;
<span class="kw">use</span> <span class="ident">ffi</span> <span class="kw">as</span> <span class="ident">glib_ffi</span>;
<span class="macro">glib_wrapper</span><span class="macro">!</span> {
<span class="doccomment">/// A generic error capable of representing various error domains (types).</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Error</span>(<span class="ident">Boxed</span><span class="op"><</span><span class="ident">glib_ffi</span>::<span class="ident">GError</span><span class="op">></span>);
<span class="kw">match</span> <span class="kw">fn</span> {
<span class="ident">copy</span> <span class="op">=></span> <span class="op">|</span><span class="ident">ptr</span><span class="op">|</span> <span class="ident">glib_ffi</span>::<span class="ident">g_error_copy</span>(<span class="ident">ptr</span>),
<span class="ident">free</span> <span class="op">=></span> <span class="op">|</span><span class="ident">ptr</span><span class="op">|</span> <span class="ident">glib_ffi</span>::<span class="ident">g_error_free</span>(<span class="ident">ptr</span>),
}
}
<span class="kw">impl</span> <span class="ident">Error</span> {
<span class="doccomment">/// Creates an error with supplied error enum variant and message.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">ErrorDomain</span><span class="op">></span>(<span class="ident">error</span>: <span class="ident">T</span>, <span class="ident">message</span>: <span class="kw-2">&</span><span class="ident">str</span>) <span class="op">-></span> <span class="ident">Error</span> {
<span class="kw">unsafe</span> {
<span class="ident">from_glib_full</span>(
<span class="ident">glib_ffi</span>::<span class="ident">g_error_new_literal</span>(<span class="ident">T</span>::<span class="ident">domain</span>(), <span class="ident">error</span>.<span class="ident">code</span>(), <span class="ident">message</span>.<span class="ident">to_glib_none</span>().<span class="number">0</span>))
}
}
<span class="doccomment">/// Checks if the error domain matches `T`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">ErrorDomain</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">bool</span> {
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">domain</span> <span class="op">==</span> <span class="ident">T</span>::<span class="ident">domain</span>()
}
<span class="doccomment">/// Tries to convert to a specific error enum.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Returns `Some` if the error belongs to the enum's error domain and</span>
<span class="doccomment">/// `None` otherwise.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```ignore</span>
<span class="doccomment">/// if let Some(file_error) = error.kind::<FileError>() {</span>
<span class="doccomment">/// match file_error {</span>
<span class="doccomment">/// FileError::Exist => ...</span>
<span class="doccomment">/// FileError::Isdir => ...</span>
<span class="doccomment">/// ...</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```ignore</span>
<span class="doccomment">/// match error {</span>
<span class="doccomment">/// Some(FileError::Exist) => ...</span>
<span class="doccomment">/// Some(FileError::Isdir) => ...</span>
<span class="doccomment">/// ...</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// ```</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">kind</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">ErrorDomain</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="kw">if</span> <span class="self">self</span>.<span class="number">0</span>.<span class="ident">domain</span> <span class="op">==</span> <span class="ident">T</span>::<span class="ident">domain</span>() {
<span class="ident">T</span>::<span class="ident">from</span>(<span class="self">self</span>.<span class="number">0</span>.<span class="ident">code</span>)
}
<span class="kw">else</span> {
<span class="prelude-val">None</span>
}
}
<span class="kw">fn</span> <span class="ident">message</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="kw">unsafe</span> {
<span class="kw">let</span> <span class="ident">bytes</span> <span class="op">=</span> <span class="ident">CStr</span>::<span class="ident">from_ptr</span>(<span class="self">self</span>.<span class="number">0</span>.<span class="ident">message</span>).<span class="ident">to_bytes</span>();
<span class="ident">str</span>::<span class="ident">from_utf8</span>(<span class="ident">bytes</span>).<span class="ident">unwrap_or_else</span>(<span class="op">|</span><span class="ident">err</span><span class="op">|</span> {
<span class="ident">str</span>::<span class="ident">from_utf8</span>(<span class="kw-2">&</span><span class="ident">bytes</span>[..<span class="ident">err</span>.<span class="ident">valid_up_to</span>()]).<span class="ident">unwrap</span>()
})
}
}
<span class="comment">// backcompat shim</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">wrap</span>(<span class="ident">ptr</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">glib_ffi</span>::<span class="ident">GError</span>) <span class="op">-></span> <span class="ident">Error</span> {
<span class="kw">unsafe</span> { <span class="ident">from_glib_full</span>(<span class="ident">ptr</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="macro">write</span><span class="macro">!</span>(<span class="ident">f</span>, <span class="string">"{}"</span>, <span class="self">self</span>.<span class="ident">message</span>())
}
}
<span class="kw">impl</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="self">self</span>.<span class="ident">message</span>()
}
}
<span class="doccomment">/// `GLib` error domain.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This trait is implemented by error enums that represent error domains (types).</span>
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">ErrorDomain</span>: <span class="ident">Copy</span> {
<span class="doccomment">/// Returns the quark identifying the error domain.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// As returned from `g_some_error_quark`.</span>
<span class="kw">fn</span> <span class="ident">domain</span>() <span class="op">-></span> <span class="ident">glib_ffi</span>::<span class="ident">GQuark</span>;
<span class="doccomment">/// Gets the integer representation of the variant.</span>
<span class="kw">fn</span> <span class="ident">code</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">i32</span>;
<span class="doccomment">/// Tries to convert an integer code to an enum variant.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// By convention, the `Failed` variant, if present, is a catch-all,</span>
<span class="doccomment">/// i.e. any unrecognized codes map to it.</span>
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">code</span>: <span class="ident">i32</span>) <span class="op">-></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="self">Self</span><span class="op">></span> <span class="kw">where</span> <span class="self">Self</span>: <span class="ident">Sized</span>;
}
<span class="doccomment">/// Generic error used for functions that fail without any further information</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">BoolError</span>(<span class="kw">pub</span> <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>);
<span class="kw">impl</span> <span class="ident">BoolError</span> {
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">from_glib</span>(<span class="ident">b</span>: <span class="ident">glib_ffi</span>::<span class="ident">gboolean</span>, <span class="ident">s</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="self">Self</span><span class="op">></span> {
<span class="kw">match</span> <span class="ident">b</span> {
<span class="ident">glib_ffi</span>::<span class="ident">GFALSE</span> <span class="op">=></span> <span class="prelude-val">Err</span>(<span class="ident">BoolError</span>(<span class="ident">s</span>)),
_ <span class="op">=></span> <span class="prelude-val">Ok</span>(()),
}
}
}
<span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">BoolError</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="macro">write</span><span class="macro">!</span>(<span class="ident">f</span>, <span class="string">"{}"</span>, <span class="self">self</span>.<span class="number">0</span>)
}
}
<span class="kw">impl</span> <span class="ident">error</span>::<span class="ident">Error</span> <span class="kw">for</span> <span class="ident">BoolError</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="self">self</span>.<span class="number">0</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 = "glib";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>