hasufell
/
pnmixer-rust
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
pnmixer-rust/pnmixerlib/prefs/struct.Prefs.html

156 lines
13 KiB
HTML
Raw Normal View History

Include all modules
2017-07-16 21:45:21 +00:00
<!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="API documentation for the Rust `Prefs` struct in crate `pnmixerlib`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Prefs">
<title>pnmixerlib::prefs::Prefs - Rust</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 struct">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class='location'>Struct Prefs</p><div class="block items"><ul><li><a href="#fields">Fields</a></li><li><a href="#methods">Methods</a></li><li><a href="#implementations">Trait Implementations</a></li></ul></div><p class='location'><a href='../index.html'>pnmixerlib</a>::<wbr><a href='index.html'>prefs</a></p><script>window.sidebarCurrent = {name: 'Prefs', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</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">
<h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>pnmixerlib</a>::<wbr><a href='index.html'>prefs</a>::<wbr><a class="struct" href=''>Prefs</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../src/pnmixerlib/prefs.rs.html#201-208' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Prefs {
pub device_prefs: <a class="struct" href="../../pnmixerlib/prefs/struct.DevicePrefs.html" title="struct pnmixerlib::prefs::DevicePrefs">DevicePrefs</a>,
pub view_prefs: <a class="struct" href="../../pnmixerlib/prefs/struct.ViewPrefs.html" title="struct pnmixerlib::prefs::ViewPrefs">ViewPrefs</a>,
pub behavior_prefs: <a class="struct" href="../../pnmixerlib/prefs/struct.BehaviorPrefs.html" title="struct pnmixerlib::prefs::BehaviorPrefs">BehaviorPrefs</a>,
pub notify_prefs: <a class="struct" href="../../pnmixerlib/prefs/struct.NotifyPrefs.html" title="struct pnmixerlib::prefs::NotifyPrefs">NotifyPrefs</a>,
pub hotkey_prefs: <a class="struct" href="../../pnmixerlib/prefs/struct.HotkeyPrefs.html" title="struct pnmixerlib::prefs::HotkeyPrefs">HotkeyPrefs</a>,
}</pre><div class='docblock'><p>Main preferences struct, holding all sub-preferences.</p>
</div><h2 id='fields' class='fields'>Fields</h2><span id='structfield.device_prefs' class="structfield">
<span id='device_prefs.v' class='invisible'>
<code>device_prefs: <a class="struct" href="../../pnmixerlib/prefs/struct.DevicePrefs.html" title="struct pnmixerlib::prefs::DevicePrefs">DevicePrefs</a></code>
</span></span><span id='structfield.view_prefs' class="structfield">
<span id='view_prefs.v' class='invisible'>
<code>view_prefs: <a class="struct" href="../../pnmixerlib/prefs/struct.ViewPrefs.html" title="struct pnmixerlib::prefs::ViewPrefs">ViewPrefs</a></code>
</span></span><span id='structfield.behavior_prefs' class="structfield">
<span id='behavior_prefs.v' class='invisible'>
<code>behavior_prefs: <a class="struct" href="../../pnmixerlib/prefs/struct.BehaviorPrefs.html" title="struct pnmixerlib::prefs::BehaviorPrefs">BehaviorPrefs</a></code>
</span></span><span id='structfield.notify_prefs' class="structfield">
<span id='notify_prefs.v' class='invisible'>
<code>notify_prefs: <a class="struct" href="../../pnmixerlib/prefs/struct.NotifyPrefs.html" title="struct pnmixerlib::prefs::NotifyPrefs">NotifyPrefs</a></code>
</span></span><span id='structfield.hotkey_prefs' class="structfield">
<span id='hotkey_prefs.v' class='invisible'>
<code>hotkey_prefs: <a class="struct" href="../../pnmixerlib/prefs/struct.HotkeyPrefs.html" title="struct pnmixerlib::prefs::HotkeyPrefs">HotkeyPrefs</a></code>
</span></span><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../../pnmixerlib/prefs/struct.Prefs.html" title="struct pnmixerlib::prefs::Prefs">Prefs</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/pnmixerlib/prefs.rs.html#210-297' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>fn <a href='#method.new' class='fnname'>new</a>() -&gt; <a class="type" href="../../pnmixerlib/errors/type.Result.html" title="type pnmixerlib::errors::Result">Result</a>&lt;<a class="struct" href="../../pnmixerlib/prefs/struct.Prefs.html" title="struct pnmixerlib::prefs::Prefs">Prefs</a>&gt;</code></span></h4>
<h4 id='method.reload_config' class="method"><span id='reload_config.v' class='invisible'><code>fn <a href='#method.reload_config' class='fnname'>reload_config</a>(&amp;mut self) -&gt; <a class="type" href="../../pnmixerlib/errors/type.Result.html" title="type pnmixerlib::errors::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>&gt;</code></span></h4>
<div class='docblock'><p>Reload the current preferences from the config file.</p>
</div><h4 id='method.store_config' class="method"><span id='store_config.v' class='invisible'><code>fn <a href='#method.store_config' class='fnname'>store_config</a>(&amp;self) -&gt; <a class="type" href="../../pnmixerlib/errors/type.Result.html" title="type pnmixerlib::errors::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>&gt;</code></span></h4>
<div class='docblock'><p>Store the current preferences to the config file.</p>
</div><h4 id='method.to_str' class="method"><span id='to_str.v' class='invisible'><code>fn <a href='#method.to_str' class='fnname'>to_str</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span></h4>
<div class='docblock'><p>Conver the current preferences to a viewable String.</p>
</div><h4 id='method.get_avail_vol_control_cmd' class="method"><span id='get_avail_vol_control_cmd.v' class='invisible'><code>fn <a href='#method.get_avail_vol_control_cmd' class='fnname'>get_avail_vol_control_cmd</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;</code></span></h4>
<div class='docblock'><p>Get an available volume control command, which must exist in <code>$PATH</code>.
Tries hard to fine one,
starting with the given preference setting and falling back to the
<code>VOL_CONTROL_COMMANDS</code> slice.</p>
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../pnmixerlib/prefs/struct.Prefs.html" title="struct pnmixerlib::prefs::Prefs">Prefs</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/pnmixerlib/prefs.rs.html#198' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></h4>
<div class='docblock'><p>Formats the value using the given formatter.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../../pnmixerlib/prefs/struct.Prefs.html" title="struct pnmixerlib::prefs::Prefs">Prefs</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/pnmixerlib/prefs.rs.html#198' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -&gt; <a class="struct" href="../../pnmixerlib/prefs/struct.Prefs.html" title="struct pnmixerlib::prefs::Prefs">Prefs</a></code></span></h4>
<div class='docblock'><p>Returns the &quot;default value&quot; for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="struct" href="../../pnmixerlib/prefs/struct.Prefs.html" title="struct pnmixerlib::prefs::Prefs">Prefs</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/pnmixerlib/prefs.rs.html#299-306' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>&gt;</code></span></h4>
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
</div></div></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 = "pnmixerlib";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>