mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-04 19:18:44 +00:00
104 lines
9.1 KiB
HTML
104 lines
9.1 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 `mqueue` mod in crate `nix`."><meta name="keywords" content="rust, rustlang, rust-lang, mqueue"><title>nix::mqueue - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></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"><div class="sidebar-menu">☰</div><p class='location'>Module mqueue</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>nix</a></p><script>window.sidebarCurrent = {name: 'mqueue', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><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"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>nix</a>::<wbr><a class="mod" href=''>mqueue</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/nix/mqueue.rs.html#1-173' title='goto source code'>[src]</a></span></h1><div class='docblock'><p>Posix Message Queue functions</p>
|
||
<p><a href="http://man7.org/linux/man-pages/man7/mq_overview.7.html">Further reading and details on the C API</a></p>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.FdFlag.html"
|
||
title='struct nix::mqueue::FdFlag'>FdFlag</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.MQ_OFlag.html"
|
||
title='struct nix::mqueue::MQ_OFlag'>MQ_OFlag</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.MqAttr.html"
|
||
title='struct nix::mqueue::MqAttr'>MqAttr</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.mq_close.html"
|
||
title='fn nix::mqueue::mq_close'>mq_close</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Close a message queue</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.mq_getattr.html"
|
||
title='fn nix::mqueue::mq_getattr'>mq_getattr</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Get message queue attributes</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.mq_open.html"
|
||
title='fn nix::mqueue::mq_open'>mq_open</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Open a message queue</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.mq_receive.html"
|
||
title='fn nix::mqueue::mq_receive'>mq_receive</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Receive a message from a message queue</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.mq_remove_nonblock.html"
|
||
title='fn nix::mqueue::mq_remove_nonblock'>mq_remove_nonblock</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Convenience function.
|
||
Removes <code>O_NONBLOCK</code> attribute for a given message queue descriptor
|
||
Returns the old attributes</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.mq_send.html"
|
||
title='fn nix::mqueue::mq_send'>mq_send</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Send a message to a message queue</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.mq_set_nonblock.html"
|
||
title='fn nix::mqueue::mq_set_nonblock'>mq_set_nonblock</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Convenience function.
|
||
Sets the <code>O_NONBLOCK</code> attribute for a given message queue descriptor
|
||
Returns the old attributes</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.mq_setattr.html"
|
||
title='fn nix::mqueue::mq_setattr'>mq_setattr</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Set the attributes of the message queue. Only <code>O_NONBLOCK</code> can be set, everything else will be ignored
|
||
Returns the old attributes
|
||
It is recommend to use the <code>mq_set_nonblock()</code> and <code>mq_remove_nonblock()</code> convenience functions as they are easier to use</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.mq_unlink.html"
|
||
title='fn nix::mqueue::mq_unlink'>mq_unlink</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Remove a message queue</p>
|
||
|
||
</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><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse 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><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "nix";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |