156 lines
12 KiB
HTML
156 lines
12 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="API documentation for the Rust `AppS` struct in crate `pnmixerlib`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, AppS">
|
||
|
||
<title>pnmixerlib::app_state::AppS - 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 AppS</p><div class="block items"><ul><li><a href="#fields">Fields</a></li><li><a href="#methods">Methods</a></li></ul></div><p class='location'><a href='../index.html'>pnmixerlib</a>::<wbr><a href='index.html'>app_state</a></p><script>window.sidebarCurrent = {name: 'AppS', 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'>app_state</a>::<wbr><a class="struct" href=''>AppS</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'>−</span>]
|
||
</a>
|
||
</span><a class='srclink' href='../../src/pnmixerlib/app_state.rs.html#21-35' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct AppS {
|
||
pub gui: <a class="struct" href="../../pnmixerlib/ui_entry/struct.Gui.html" title="struct pnmixerlib::ui_entry::Gui">Gui</a>,
|
||
pub audio: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><<a class="struct" href="../../pnmixerlib/audio/struct.Audio.html" title="struct pnmixerlib::audio::Audio">Audio</a>>,
|
||
pub prefs: <a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.RefCell.html" title="struct core::cell::RefCell">RefCell</a><<a class="struct" href="../../pnmixerlib/prefs/struct.Prefs.html" title="struct pnmixerlib::prefs::Prefs">Prefs</a>>,
|
||
pub notif: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../pnmixerlib/notif/struct.Notif.html" title="struct pnmixerlib::notif::Notif">Notif</a>>,
|
||
pub hotkeys: <a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.RefCell.html" title="struct core::cell::RefCell">RefCell</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><<a class="struct" href="../../pnmixerlib/hotkeys/struct.Hotkeys.html" title="struct pnmixerlib::hotkeys::Hotkeys">Hotkeys</a>>>,
|
||
// some fields omitted
|
||
}</pre><div class='docblock'><p>The global application state struct.</p>
|
||
</div><h2 id='fields' class='fields'>Fields</h2><span id='structfield.gui' class="structfield">
|
||
<span id='gui.v' class='invisible'>
|
||
<code>gui: <a class="struct" href="../../pnmixerlib/ui_entry/struct.Gui.html" title="struct pnmixerlib::ui_entry::Gui">Gui</a></code>
|
||
</span></span><div class='docblock'><p>Mostly static GUI state.</p>
|
||
</div><span id='structfield.audio' class="structfield">
|
||
<span id='audio.v' class='invisible'>
|
||
<code>audio: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><<a class="struct" href="../../pnmixerlib/audio/struct.Audio.html" title="struct pnmixerlib::audio::Audio">Audio</a>></code>
|
||
</span></span><div class='docblock'><p>Audio state.</p>
|
||
</div><span id='structfield.prefs' class="structfield">
|
||
<span id='prefs.v' class='invisible'>
|
||
<code>prefs: <a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.RefCell.html" title="struct core::cell::RefCell">RefCell</a><<a class="struct" href="../../pnmixerlib/prefs/struct.Prefs.html" title="struct pnmixerlib::prefs::Prefs">Prefs</a>></code>
|
||
</span></span><div class='docblock'><p>Preferences state.</p>
|
||
</div><span id='structfield.notif' class="structfield">
|
||
<span id='notif.v' class='invisible'>
|
||
<code>notif: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../pnmixerlib/notif/struct.Notif.html" title="struct pnmixerlib::notif::Notif">Notif</a>></code>
|
||
</span></span><div class='docblock'><p>Notification state. In case of initialization failure, this
|
||
is set to <code>None</code>.</p>
|
||
</div><span id='structfield.hotkeys' class="structfield">
|
||
<span id='hotkeys.v' class='invisible'>
|
||
<code>hotkeys: <a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.RefCell.html" title="struct core::cell::RefCell">RefCell</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><<a class="struct" href="../../pnmixerlib/hotkeys/struct.Hotkeys.html" title="struct pnmixerlib::hotkeys::Hotkeys">Hotkeys</a>>></code>
|
||
</span></span><div class='docblock'><p>Hotkey state.</p>
|
||
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../../pnmixerlib/app_state/struct.AppS.html" title="struct pnmixerlib::app_state::AppS">AppS</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/pnmixerlib/app_state.rs.html#38-129' 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>() -> <a class="struct" href="../../pnmixerlib/app_state/struct.AppS.html" title="struct pnmixerlib::app_state::AppS">AppS</a></code></span></h4>
|
||
<div class='docblock'><p>Create an application state instance. There should really only be one.</p>
|
||
</div><h4 id='method.update_tray_icon' class="method"><span id='update_tray_icon.v' class='invisible'><code>fn <a href='#method.update_tray_icon' class='fnname'>update_tray_icon</a>(&self) -> <a class="type" href="../../pnmixerlib/errors/type.Result.html" title="type pnmixerlib::errors::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h4>
|
||
<div class='docblock'><p>Update the tray icon state.</p>
|
||
</div><h4 id='method.update_popup_window' class="method"><span id='update_popup_window.v' class='invisible'><code>fn <a href='#method.update_popup_window' class='fnname'>update_popup_window</a>(&self) -> <a class="type" href="../../pnmixerlib/errors/type.Result.html" title="type pnmixerlib::errors::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h4>
|
||
<div class='docblock'><p>Update the Popup Window state.</p>
|
||
</div><h4 id='method.update_notify' class="method"><span id='update_notify.v' class='invisible'><code>fn <a href='#method.update_notify' class='fnname'>update_notify</a>(&self)</code></span></h4>
|
||
<div class='docblock'><p>Update the notification state.</p>
|
||
</div><h4 id='method.update_audio' class="method"><span id='update_audio.v' class='invisible'><code>fn <a href='#method.update_audio' class='fnname'>update_audio</a>(&self, user: <a class="enum" href="../../pnmixerlib/audio/enum.AudioUser.html" title="enum pnmixerlib::audio::AudioUser">AudioUser</a>) -> <a class="type" href="../../pnmixerlib/errors/type.Result.html" title="type pnmixerlib::errors::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h4>
|
||
<div class='docblock'><p>Update the audio state.</p>
|
||
</div><h4 id='method.update_config' class="method"><span id='update_config.v' class='invisible'><code>fn <a href='#method.update_config' class='fnname'>update_config</a>(&self) -> <a class="type" href="../../pnmixerlib/errors/type.Result.html" title="type pnmixerlib::errors::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h4>
|
||
<div class='docblock'><p>Update the config file.</p>
|
||
</div><h4 id='method.update_hotkeys' class="method"><span id='update_hotkeys.v' class='invisible'><code>fn <a href='#method.update_hotkeys' class='fnname'>update_hotkeys</a>(&self) -> <a class="type" href="../../pnmixerlib/errors/type.Result.html" title="type pnmixerlib::errors::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h4>
|
||
<div class='docblock'><p>Update hotkey state.</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>⇤</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 = "pnmixerlib";
|
||
</script>
|
||
<script src="../../main.js"></script>
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |