612 lines
31 KiB
HTML
612 lines
31 KiB
HTML
<!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 `src/notification.rs`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang">
|
||
|
||
<title>notification.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>
|
||
<span id="141">141</span>
|
||
<span id="142">142</span>
|
||
<span id="143">143</span>
|
||
<span id="144">144</span>
|
||
<span id="145">145</span>
|
||
<span id="146">146</span>
|
||
<span id="147">147</span>
|
||
<span id="148">148</span>
|
||
<span id="149">149</span>
|
||
<span id="150">150</span>
|
||
<span id="151">151</span>
|
||
<span id="152">152</span>
|
||
<span id="153">153</span>
|
||
<span id="154">154</span>
|
||
<span id="155">155</span>
|
||
<span id="156">156</span>
|
||
<span id="157">157</span>
|
||
<span id="158">158</span>
|
||
<span id="159">159</span>
|
||
<span id="160">160</span>
|
||
<span id="161">161</span>
|
||
<span id="162">162</span>
|
||
<span id="163">163</span>
|
||
<span id="164">164</span>
|
||
<span id="165">165</span>
|
||
<span id="166">166</span>
|
||
<span id="167">167</span>
|
||
<span id="168">168</span>
|
||
<span id="169">169</span>
|
||
<span id="170">170</span>
|
||
<span id="171">171</span>
|
||
<span id="172">172</span>
|
||
<span id="173">173</span>
|
||
<span id="174">174</span>
|
||
<span id="175">175</span>
|
||
<span id="176">176</span>
|
||
<span id="177">177</span>
|
||
<span id="178">178</span>
|
||
<span id="179">179</span>
|
||
<span id="180">180</span>
|
||
<span id="181">181</span>
|
||
<span id="182">182</span>
|
||
<span id="183">183</span>
|
||
<span id="184">184</span>
|
||
<span id="185">185</span>
|
||
<span id="186">186</span>
|
||
<span id="187">187</span>
|
||
<span id="188">188</span>
|
||
<span id="189">189</span>
|
||
<span id="190">190</span>
|
||
<span id="191">191</span>
|
||
<span id="192">192</span>
|
||
<span id="193">193</span>
|
||
<span id="194">194</span>
|
||
<span id="195">195</span>
|
||
<span id="196">196</span>
|
||
<span id="197">197</span>
|
||
<span id="198">198</span>
|
||
<span id="199">199</span>
|
||
<span id="200">200</span>
|
||
<span id="201">201</span>
|
||
<span id="202">202</span>
|
||
<span id="203">203</span>
|
||
<span id="204">204</span>
|
||
<span id="205">205</span>
|
||
<span id="206">206</span>
|
||
<span id="207">207</span>
|
||
<span id="208">208</span>
|
||
<span id="209">209</span>
|
||
<span id="210">210</span>
|
||
<span id="211">211</span>
|
||
<span id="212">212</span>
|
||
<span id="213">213</span>
|
||
<span id="214">214</span>
|
||
<span id="215">215</span>
|
||
<span id="216">216</span>
|
||
<span id="217">217</span>
|
||
<span id="218">218</span>
|
||
<span id="219">219</span>
|
||
<span id="220">220</span>
|
||
<span id="221">221</span>
|
||
<span id="222">222</span>
|
||
<span id="223">223</span>
|
||
<span id="224">224</span>
|
||
<span id="225">225</span>
|
||
<span id="226">226</span>
|
||
<span id="227">227</span>
|
||
<span id="228">228</span>
|
||
<span id="229">229</span>
|
||
<span id="230">230</span>
|
||
<span id="231">231</span>
|
||
<span id="232">232</span>
|
||
<span id="233">233</span>
|
||
<span id="234">234</span>
|
||
<span id="235">235</span>
|
||
<span id="236">236</span>
|
||
<span id="237">237</span>
|
||
<span id="238">238</span>
|
||
<span id="239">239</span>
|
||
<span id="240">240</span>
|
||
<span id="241">241</span>
|
||
<span id="242">242</span>
|
||
<span id="243">243</span>
|
||
<span id="244">244</span>
|
||
<span id="245">245</span>
|
||
<span id="246">246</span>
|
||
<span id="247">247</span>
|
||
<span id="248">248</span>
|
||
<span id="249">249</span>
|
||
<span id="250">250</span>
|
||
<span id="251">251</span>
|
||
</pre><pre class="rust ">
|
||
<span class="kw">use</span> <span class="ident">Urgency</span>;
|
||
<span class="kw">use</span> <span class="ident">ffi</span>;
|
||
<span class="kw">use</span> <span class="ident">gdk_pixbuf</span>;
|
||
<span class="kw">use</span> <span class="ident">glib</span>::<span class="ident">translate</span>::<span class="kw-2">*</span>;
|
||
<span class="kw">use</span> <span class="ident">glib</span>;
|
||
<span class="kw">use</span> <span class="ident">glib_ffi</span>;
|
||
<span class="kw">use</span> <span class="ident">gobject_ffi</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">mem</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="macro">glib_wrapper</span><span class="macro">!</span> {
|
||
<span class="doccomment">/// `Notification` represents a passive pop-up notification. It can contain</span>
|
||
<span class="doccomment">/// summary text, body text, and an icon, as well as hints specifying how</span>
|
||
<span class="doccomment">/// the notification should be presented. The notification is rendered by</span>
|
||
<span class="doccomment">/// a notification daemon, and may present the notification in any number</span>
|
||
<span class="doccomment">/// of ways. As such, there is a clear separation of content and</span>
|
||
<span class="doccomment">/// presentation, and this API enforces that.</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Notification</span>(<span class="ident">Object</span><span class="op"><</span><span class="ident">ffi</span>::<span class="ident">NotifyNotification</span><span class="op">></span>);
|
||
|
||
<span class="kw">match</span> <span class="kw">fn</span> {
|
||
<span class="ident">get_type</span> <span class="op">=></span> <span class="op">||</span> <span class="ident">ffi</span>::<span class="ident">notify_notification_get_type</span>(),
|
||
}
|
||
}
|
||
|
||
|
||
|
||
<span class="kw">impl</span> <span class="ident">Notification</span> {
|
||
<span class="doccomment">/// Creates a new `Notification`. The summary text is required, but</span>
|
||
<span class="doccomment">/// all other parameters are optional.</span>
|
||
<span class="doccomment">/// ## `summary`</span>
|
||
<span class="doccomment">/// The required summary text.</span>
|
||
<span class="doccomment">/// ## `body`</span>
|
||
<span class="doccomment">/// The optional body text.</span>
|
||
<span class="doccomment">/// ## `icon`</span>
|
||
<span class="doccomment">/// The optional icon theme icon name or filename.</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// # Returns</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// The new `Notification`.</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="lifetime">'b</span>, <span class="ident">P</span>: <span class="ident">Into</span><span class="op"><</span><span class="prelude-ty">Option</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="ident">Q</span>: <span class="ident">Into</span><span class="op"><</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'b</span> <span class="ident">str</span><span class="op">>></span><span class="op">></span>(
|
||
<span class="ident">summary</span>: <span class="kw-2">&</span><span class="ident">str</span>,
|
||
<span class="ident">body</span>: <span class="ident">P</span>,
|
||
<span class="ident">icon</span>: <span class="ident">Q</span>,
|
||
) <span class="op">-></span> <span class="ident">Notification</span> {
|
||
<span class="macro">assert_initialized_libnotify</span><span class="macro">!</span>();
|
||
<span class="kw">let</span> <span class="ident">body</span> <span class="op">=</span> <span class="ident">body</span>.<span class="ident">into</span>();
|
||
<span class="kw">let</span> <span class="ident">body</span> <span class="op">=</span> <span class="ident">body</span>.<span class="ident">to_glib_none</span>();
|
||
<span class="kw">let</span> <span class="ident">icon</span> <span class="op">=</span> <span class="ident">icon</span>.<span class="ident">into</span>();
|
||
<span class="kw">let</span> <span class="ident">icon</span> <span class="op">=</span> <span class="ident">icon</span>.<span class="ident">to_glib_none</span>();
|
||
<span class="kw">unsafe</span> {
|
||
<span class="ident">from_glib_full</span>(<span class="ident">ffi</span>::<span class="ident">notify_notification_new</span>(
|
||
<span class="ident">summary</span>.<span class="ident">to_glib_none</span>().<span class="number">0</span>,
|
||
<span class="ident">body</span>.<span class="number">0</span>,
|
||
<span class="ident">icon</span>.<span class="number">0</span>,
|
||
))
|
||
}
|
||
}
|
||
|
||
<span class="doccomment">/// Synchronously tells the notification server to hide the notification on the screen.</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// # Returns</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// `Ok(())` on success, or `Err(err)` on error</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">close</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">glib</span>::<span class="ident">error</span>::<span class="ident">Error</span><span class="op">></span> {
|
||
<span class="macro">assert_initialized_libnotify</span><span class="macro">!</span>();
|
||
<span class="kw">unsafe</span> {
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">err</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">std</span>::<span class="ident">ptr</span>::<span class="ident">null_mut</span>();
|
||
<span class="ident">ffi</span>::<span class="ident">notify_notification_close</span>(<span class="self">self</span>.<span class="ident">to_glib_none</span>().<span class="number">0</span>, <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">err</span>);
|
||
|
||
<span class="kw">if</span> <span class="op">!</span><span class="ident">err</span>.<span class="ident">is_null</span>() {
|
||
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">glib</span>::<span class="ident">error</span>::<span class="ident">Error</span>::<span class="ident">wrap</span>(<span class="ident">err</span>));
|
||
} <span class="kw">else</span> {
|
||
<span class="kw">return</span> <span class="prelude-val">Ok</span>(());
|
||
}
|
||
}
|
||
}
|
||
|
||
<span class="doccomment">/// Tells the notification server to display the notification on the screen.</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// # Returns</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// `Ok(())` on success, or `Err(err)` on error</span>
|
||
<span class="comment">// TODO: test if Error leaks memory</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">show</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">glib</span>::<span class="ident">error</span>::<span class="ident">Error</span><span class="op">></span> {
|
||
<span class="macro">assert_initialized_libnotify</span><span class="macro">!</span>();
|
||
<span class="kw">unsafe</span> {
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">err</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">std</span>::<span class="ident">ptr</span>::<span class="ident">null_mut</span>();
|
||
<span class="ident">ffi</span>::<span class="ident">notify_notification_show</span>(<span class="self">self</span>.<span class="ident">to_glib_none</span>().<span class="number">0</span>, <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">err</span>);
|
||
|
||
<span class="kw">if</span> <span class="op">!</span><span class="ident">err</span>.<span class="ident">is_null</span>() {
|
||
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">glib</span>::<span class="ident">error</span>::<span class="ident">Error</span>::<span class="ident">wrap</span>(<span class="ident">err</span>));
|
||
} <span class="kw">else</span> {
|
||
<span class="kw">return</span> <span class="prelude-val">Ok</span>(());
|
||
}
|
||
}
|
||
}
|
||
|
||
<span class="doccomment">/// Sets a hint for `key` with value `value`. If `value` is `None`,</span>
|
||
<span class="doccomment">/// a previously set hint for `key` is unset.</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// If `value` is floating, it is consumed.</span>
|
||
<span class="doccomment">/// ## `key`</span>
|
||
<span class="doccomment">/// the hint key</span>
|
||
<span class="doccomment">/// ## `value`</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_hint</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">key</span>: <span class="kw-2">&</span><span class="ident">str</span>, <span class="ident">value</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">glib</span>::<span class="ident">variant</span>::<span class="ident">Variant</span><span class="op">></span>) {
|
||
<span class="macro">assert_initialized_libnotify</span><span class="macro">!</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">gvalue</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">glib_ffi</span>::<span class="ident">GVariant</span> <span class="op">=</span> {
|
||
<span class="kw">match</span> <span class="ident">value</span> {
|
||
<span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">value</span>) <span class="op">=></span> <span class="ident">value</span>.<span class="ident">to_glib_none</span>().<span class="number">0</span>,
|
||
<span class="prelude-val">None</span> <span class="op">=></span> <span class="ident">std</span>::<span class="ident">ptr</span>::<span class="ident">null_mut</span>(),
|
||
}
|
||
};
|
||
|
||
<span class="kw">unsafe</span> {
|
||
<span class="ident">ffi</span>::<span class="ident">notify_notification_set_hint</span>(
|
||
<span class="self">self</span>.<span class="ident">to_glib_none</span>().<span class="number">0</span>,
|
||
<span class="ident">key</span>.<span class="ident">to_glib_none</span>().<span class="number">0</span>,
|
||
<span class="ident">gvalue</span>,
|
||
)
|
||
}
|
||
}
|
||
|
||
<span class="doccomment">/// Sets the image in the notification from a `gdk_pixbuf::Pixbuf`.</span>
|
||
<span class="doccomment">/// ## `pixbuf`</span>
|
||
<span class="doccomment">/// The image.</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_image_from_pixbuf</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">pixbuf</span>: <span class="kw-2">&</span><span class="ident">gdk_pixbuf</span>::<span class="ident">Pixbuf</span>) {
|
||
<span class="macro">assert_initialized_libnotify</span><span class="macro">!</span>();
|
||
|
||
<span class="kw">unsafe</span> {
|
||
<span class="ident">ffi</span>::<span class="ident">notify_notification_set_image_from_pixbuf</span>(
|
||
<span class="self">self</span>.<span class="ident">to_glib_none</span>().<span class="number">0</span>,
|
||
<span class="ident">pixbuf</span>.<span class="ident">to_glib_none</span>().<span class="number">0</span>,
|
||
);
|
||
}
|
||
}
|
||
|
||
<span class="doccomment">/// Clears all hints from the notification.</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">clear_hints</span>(<span class="kw-2">&</span><span class="self">self</span>) {
|
||
<span class="kw">unsafe</span> {
|
||
<span class="ident">ffi</span>::<span class="ident">notify_notification_clear_hints</span>(<span class="self">self</span>.<span class="ident">to_glib_none</span>().<span class="number">0</span>);
|
||
}
|
||
}
|
||
|
||
<span class="doccomment">/// Sets the application name for the notification. If this function is</span>
|
||
<span class="doccomment">/// not called or if `app_name` is `None`, the application name will be</span>
|
||
<span class="doccomment">/// set from the value used in `notify_init` or overridden with</span>
|
||
<span class="doccomment">/// `notify_set_app_name`.</span>
|
||
<span class="doccomment">/// ## `app_name`</span>
|
||
<span class="doccomment">/// the localised application name</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_app_name</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">P</span>: <span class="ident">Into</span><span class="op"><</span><span class="prelude-ty">Option</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="op">></span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">app_name</span>: <span class="ident">P</span>) {
|
||
<span class="kw">let</span> <span class="ident">app_name</span> <span class="op">=</span> <span class="ident">app_name</span>.<span class="ident">into</span>();
|
||
<span class="kw">let</span> <span class="ident">app_name</span> <span class="op">=</span> <span class="ident">app_name</span>.<span class="ident">to_glib_none</span>();
|
||
<span class="kw">unsafe</span> {
|
||
<span class="ident">ffi</span>::<span class="ident">notify_notification_set_app_name</span>(
|
||
<span class="self">self</span>.<span class="ident">to_glib_none</span>().<span class="number">0</span>,
|
||
<span class="ident">app_name</span>.<span class="number">0</span>,
|
||
);
|
||
}
|
||
}
|
||
|
||
<span class="doccomment">/// Sets the category of this notification. This can be used by the</span>
|
||
<span class="doccomment">/// notification server to filter or display the data in a certain way.</span>
|
||
<span class="doccomment">/// ## `category`</span>
|
||
<span class="doccomment">/// The category.</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_category</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">category</span>: <span class="kw-2">&</span><span class="ident">str</span>) {
|
||
<span class="kw">unsafe</span> {
|
||
<span class="ident">ffi</span>::<span class="ident">notify_notification_set_category</span>(
|
||
<span class="self">self</span>.<span class="ident">to_glib_none</span>().<span class="number">0</span>,
|
||
<span class="ident">category</span>.<span class="ident">to_glib_none</span>().<span class="number">0</span>,
|
||
);
|
||
}
|
||
}
|
||
|
||
<span class="doccomment">/// Sets the timeout of the notification. To set the default time, pass</span>
|
||
<span class="doccomment">/// `NOTIFY_EXPIRES_DEFAULT` as `timeout`. To set the notification to never</span>
|
||
<span class="doccomment">/// expire, pass `NOTIFY_EXPIRES_NEVER`.</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// Note that the timeout may be ignored by the server.</span>
|
||
<span class="doccomment">/// ## `timeout`</span>
|
||
<span class="doccomment">/// The timeout in milliseconds.</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_timeout</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">timeout</span>: <span class="ident">i32</span>) {
|
||
<span class="kw">unsafe</span> {
|
||
<span class="ident">ffi</span>::<span class="ident">notify_notification_set_timeout</span>(
|
||
<span class="self">self</span>.<span class="ident">to_glib_none</span>().<span class="number">0</span>,
|
||
<span class="ident">timeout</span>,
|
||
);
|
||
}
|
||
}
|
||
|
||
<span class="doccomment">/// Sets the urgency level of this notification.</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// See: `Urgency`</span>
|
||
<span class="doccomment">/// ## `urgency`</span>
|
||
<span class="doccomment">/// The urgency level.</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_urgency</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">urgency</span>: <span class="ident">Urgency</span>) {
|
||
<span class="kw">unsafe</span> {
|
||
<span class="ident">ffi</span>::<span class="ident">notify_notification_set_urgency</span>(
|
||
<span class="self">self</span>.<span class="ident">to_glib_none</span>().<span class="number">0</span>,
|
||
<span class="ident">urgency</span>.<span class="ident">to_glib</span>(),
|
||
);
|
||
}
|
||
}
|
||
|
||
<span class="doccomment">/// Updates the notification text and icon. This won't send the update out</span>
|
||
<span class="doccomment">/// and display it on the screen. For that, you will need to call</span>
|
||
<span class="doccomment">/// `Notification::show`.</span>
|
||
<span class="doccomment">/// ## `summary`</span>
|
||
<span class="doccomment">/// The new required summary text.</span>
|
||
<span class="doccomment">/// ## `body`</span>
|
||
<span class="doccomment">/// The optional body text.</span>
|
||
<span class="doccomment">/// ## `icon`</span>
|
||
<span class="doccomment">/// The optional icon theme icon name or filename.</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// # Returns</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// `Ok(())` on success, or `Err(str)` if an invalid parameter was passed</span>
|
||
<span class="comment">// TODO: switch back to BoolError when it hits stable glib</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">update</span><span class="op"><</span>
|
||
<span class="lifetime">'a</span>,
|
||
<span class="lifetime">'b</span>,
|
||
<span class="ident">P</span>: <span class="ident">Into</span><span class="op"><</span><span class="prelude-ty">Option</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="ident">Q</span>: <span class="ident">Into</span><span class="op"><</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'b</span> <span class="ident">str</span><span class="op">>></span>,
|
||
<span class="op">></span>(
|
||
<span class="kw-2">&</span><span class="self">self</span>,
|
||
<span class="ident">summary</span>: <span class="kw-2">&</span><span class="ident">str</span>,
|
||
<span class="ident">body</span>: <span class="ident">P</span>,
|
||
<span class="ident">icon</span>: <span class="ident">Q</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">let</span> <span class="ident">body</span> <span class="op">=</span> <span class="ident">body</span>.<span class="ident">into</span>();
|
||
<span class="kw">let</span> <span class="ident">body</span> <span class="op">=</span> <span class="ident">body</span>.<span class="ident">to_glib_none</span>();
|
||
<span class="kw">let</span> <span class="ident">icon</span> <span class="op">=</span> <span class="ident">icon</span>.<span class="ident">into</span>();
|
||
<span class="kw">let</span> <span class="ident">icon</span> <span class="op">=</span> <span class="ident">icon</span>.<span class="ident">to_glib_none</span>();
|
||
<span class="kw">unsafe</span> {
|
||
<span class="kw">let</span> <span class="ident">b</span> <span class="op">=</span> <span class="ident">ffi</span>::<span class="ident">notify_notification_update</span>(
|
||
<span class="self">self</span>.<span class="ident">to_glib_none</span>().<span class="number">0</span>,
|
||
<span class="ident">summary</span>.<span class="ident">to_glib_none</span>().<span class="number">0</span>,
|
||
<span class="ident">body</span>.<span class="number">0</span>,
|
||
<span class="ident">icon</span>.<span class="number">0</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">String</span>::<span class="ident">from</span>(<span class="string">"Invalid parameter passed"</span>),
|
||
),
|
||
_ <span class="op">=></span> <span class="prelude-val">Ok</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>Switch tab</dd>
|
||
<dt>⏎</dt>
|
||
<dd>Go to active search result</dd>
|
||
<dt style="width:31px;">+ / -</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 = "libnotify";
|
||
</script>
|
||
<script src="../../main.js"></script>
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |