pnmixer-rust/index.html

278 lines
16 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `pnmixerlib` crate.">
<meta name="keywords" content="rust, rustlang, rust-lang, pnmixerlib">
<title>pnmixerlib - 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 mod">
<!--[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'>Crate pnmixerlib</p><div class="block items"><ul><li><a href="#reexports">Reexports</a></li><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'pnmixerlib', ty: 'mod', relpath: '../'};</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'>Crate <a class="mod" href=''>pnmixerlib</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/lib.rs.html#1-61' title='goto source code'>[src]</a></span></h1>
<h2 id='reexports' class='section-header'><a href="#reexports">Reexports</a></h2>
<table><tr><td><code>pub extern crate <a class="mod" href="../flexi_logger/index.html" title="mod flexi_logger">flexi_logger</a>;</code></td></tr><tr><td><code>pub extern crate <a class="mod" href="../log/index.html" title="mod log">log</a>;</code></td></tr><tr><td><code>pub extern crate <a class="mod" href="../error_chain/index.html" title="mod error_chain">error_chain</a>;</code></td></tr><tr><td><code>pub extern crate <a class="mod" href="../serde_derive/index.html" title="mod serde_derive">serde_derive</a>;</code></td></tr><tr><td><code>pub extern crate <a class="mod" href="../toml/index.html" title="mod toml">toml</a>;</code></td></tr><tr><td><code>pub extern crate <a class="mod" href="../serde/index.html" title="mod serde">serde</a>;</code></td></tr><tr><td><code>pub extern crate <a class="mod" href="../alsa/index.html" title="mod alsa">alsa</a>;</code></td></tr><tr><td><code>pub extern crate <a class="mod" href="../alsa_sys/index.html" title="mod alsa_sys">alsa_sys</a>;</code></td></tr><tr><td><code>pub extern crate <a class="mod" href="../ffi/index.html" title="mod ffi">ffi</a>;</code></td></tr><tr><td><code>pub extern crate <a class="mod" href="../gdk/index.html" title="mod gdk">gdk</a>;</code></td></tr><tr><td><code>pub extern crate <a class="mod" href="../gdk_pixbuf/index.html" title="mod gdk_pixbuf">gdk_pixbuf</a>;</code></td></tr><tr><td><code>pub extern crate <a class="mod" href="../gdk_pixbuf_sys/index.html" title="mod gdk_pixbuf_sys">gdk_pixbuf_sys</a>;</code></td></tr><tr><td><code>pub extern crate <a class="mod" href="../gdk_sys/index.html" title="mod gdk_sys">gdk_sys</a>;</code></td></tr><tr><td><code>pub extern crate <a class="mod" href="../gio/index.html" title="mod gio">gio</a>;</code></td></tr><tr><td><code>pub extern crate <a class="mod" href="../glib/index.html" title="mod glib">glib</a>;</code></td></tr><tr><td><code>pub extern crate <a class="mod" href="../glib_sys/index.html" title="mod glib_sys">glib_sys</a>;</code></td></tr><tr><td><code>pub extern crate <a class="mod" href="../gobject_sys/index.html" title="mod gobject_sys">gobject_sys</a>;</code></td></tr><tr><td><code>pub extern crate <a class="mod" href="../gtk/index.html" title="mod gtk">gtk</a>;</code></td></tr><tr><td><code>pub extern crate <a class="mod" href="../gtk_sys/index.html" title="mod gtk_sys">gtk_sys</a>;</code></td></tr><tr><td><code>pub extern crate <a class="mod" href="../libc/index.html" title="mod libc">libc</a>;</code></td></tr><tr><td><code>pub extern crate <a class="mod" href="../png/index.html" title="mod png">png</a>;</code></td></tr><tr><td><code>pub extern crate <a class="mod" href="../which/index.html" title="mod which">which</a>;</code></td></tr><tr><td><code>pub extern crate <a class="mod" href="../xdg/index.html" title="mod xdg">xdg</a>;</code></td></tr><tr><td><code>pub extern crate <a class="mod" href="../libnotify/index.html" title="mod libnotify">libnotify</a>;</code></td></tr></table><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table>
<tr class=' module-item'>
<td><a class="mod" href="alsa_card/index.html"
title='mod pnmixerlib::alsa_card'>alsa_card</a></td>
<td class='docblock-short'>
<p>Alsa audio subsystem.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="app_state/index.html"
title='mod pnmixerlib::app_state'>app_state</a></td>
<td class='docblock-short'>
<p>Global application state.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="audio/index.html"
title='mod pnmixerlib::audio'>audio</a></td>
<td class='docblock-short'>
<p>High-level audio subsystem.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="errors/index.html"
title='mod pnmixerlib::errors'>errors</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="glade_helpers/index.html"
title='mod pnmixerlib::glade_helpers'>glade_helpers</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="notif/index.html"
title='mod pnmixerlib::notif'>notif</a></td>
<td class='docblock-short'>
<p>The notification subsystem.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="prefs/index.html"
title='mod pnmixerlib::prefs'>prefs</a></td>
<td class='docblock-short'>
<p>The preferences subsystem.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="support_alsa/index.html"
title='mod pnmixerlib::support_alsa'>support_alsa</a></td>
<td class='docblock-short'>
<p>Alsa audio helper functions.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="support_audio/index.html"
title='mod pnmixerlib::support_audio'>support_audio</a></td>
<td class='docblock-short'>
<p>Helper functions of the audio subsystem.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="support_cmd/index.html"
title='mod pnmixerlib::support_cmd'>support_cmd</a></td>
<td class='docblock-short'>
<p>Helper functions for invoking system commands.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="support_ui/index.html"
title='mod pnmixerlib::support_ui'>support_ui</a></td>
<td class='docblock-short'>
<p>Helper functions for the UI, mostly pixbuf functions.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="ui_entry/index.html"
title='mod pnmixerlib::ui_entry'>ui_entry</a></td>
<td class='docblock-short'>
<p>Global GUI state.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="ui_popup_menu/index.html"
title='mod pnmixerlib::ui_popup_menu'>ui_popup_menu</a></td>
<td class='docblock-short'>
<p>The popup menu subsystem when the user right-clicks on the tray icon.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="ui_popup_window/index.html"
title='mod pnmixerlib::ui_popup_window'>ui_popup_window</a></td>
<td class='docblock-short'>
<p>The popup window subsystem when the user left-clicks on the tray icon.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="ui_prefs_dialog/index.html"
title='mod pnmixerlib::ui_prefs_dialog'>ui_prefs_dialog</a></td>
<td class='docblock-short'>
<p>The preferences window subsystem, when the user clicks the &quot;Preferences&quot;
menu item on the popup menu.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="ui_tray_icon/index.html"
title='mod pnmixerlib::ui_tray_icon'>ui_tray_icon</a></td>
<td class='docblock-short'>
<p>The tray icon subsystem.</p>
</td>
</tr></table><h2 id='macros' class='section-header'><a href="#macros">Macros</a></h2>
<table>
<tr class=' module-item'>
<td><a class="macro" href="macro.create_builder_item.html"
title='macro pnmixerlib::create_builder_item'>create_builder_item</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="macro" href="macro.pixbuf_new_from_png.html"
title='macro pnmixerlib::pixbuf_new_from_png'>pixbuf_new_from_png</a></td>
<td class='docblock-short'>
<p>Create a pixbuf from the given PNG file. Includes the file as bytes
in the binary and decodes it.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="macro" href="macro.try_e.html"
title='macro pnmixerlib::try_e'>try_e</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="macro" href="macro.try_er.html"
title='macro pnmixerlib::try_er'>try_er</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="macro" href="macro.try_r.html"
title='macro pnmixerlib::try_r'>try_r</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="macro" href="macro.try_w.html"
title='macro pnmixerlib::try_w'>try_w</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="macro" href="macro.try_wr.html"
title='macro pnmixerlib::try_wr'>try_wr</a></td>
<td class='docblock-short'>
</td>
</tr></table></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>