OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-29 13:22:37 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
f4bb79d2d629ee5166f17b80ca2aa0e621d1c837
google-apis-rs/mio/index.html
Sebastian Thiel f4bb79d2d6 Update documentation
2024-03-05 21:06:01 +01:00

17 lines
7.7 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="Mio is a fast, low-level I/O library for Rust focusing on non-blocking APIs and event notification for building high performance I/O apps with as little overhead as possible over the OS abstractions."><title>mio - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../mio/index.html">mio</a><span class="version">0.8.8</span></h2></div><div class="sidebar-elems"><ul class="block">
<li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li></ul></section></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../mio/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">mio</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/mio/lib.rs.html#1-266">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Mio is a fast, low-level I/O library for Rust focusing on non-blocking APIs
and event notification for building high performance I/O apps with as little
overhead as possible over the OS abstractions.</p>
<h2 id="usage"><a href="#usage">Usage</a></h2>
<p>Using Mio starts by creating a <a href="../mio/struct.Poll.html"><code>Poll</code></a>, which reads events from the OS and
puts them into <a href="../mio/event/struct.Events.html"><code>Events</code></a>. You can handle I/O events from the OS with it.</p>
<p>For more detail, see <a href="../mio/struct.Poll.html"><code>Poll</code></a>.</p>
<h3 id="examples"><a href="#examples">Examples</a></h3>
<p>Examples can found in the <code>examples</code> directory of the source code, or <a href="https://github.com/tokio-rs/mio/tree/master/examples">on
GitHub</a>.</p>
<h3 id="guide"><a href="#guide">Guide</a></h3>
<p>A getting started guide is available in the <a href="guide/index.html" title="mod mio::guide"><code>guide</code></a> module.</p>
<h3 id="available-features"><a href="#available-features">Available features</a></h3>
<p>The available features are described in the <a href="features/index.html" title="mod mio::features"><code>features</code></a> module.</p>
</div></details><h2 id="reexports" class="section-header"><a href="#reexports">Re-exports</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.Events"><code>pub use event::<a class="struct" href="event/struct.Events.html" title="struct mio::event::Events">Events</a>;</code></div></li></ul><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="event/index.html" title="mod mio::event">event</a></div><div class="desc docblock-short">Readiness event types and utilities.</div></li><li><div class="item-name"><a class="mod" href="features/index.html" title="mod mio::features">features</a></div><div class="desc docblock-short">Mio’s optional features.</div></li><li><div class="item-name"><a class="mod" href="guide/index.html" title="mod mio::guide">guide</a></div><div class="desc docblock-short">Getting started guide.</div></li><li><div class="item-name"><a class="mod" href="net/index.html" title="mod mio::net">net</a></div><div class="desc docblock-short">Networking primitives.</div></li><li><div class="item-name"><a class="mod" href="unix/index.html" title="mod mio::unix">unix</a></div><div class="desc docblock-short">Unix only extensions.</div></li></ul><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Interest.html" title="struct mio::Interest">Interest</a></div><div class="desc docblock-short">Interest used in registering.</div></li><li><div class="item-name"><a class="struct" href="struct.Poll.html" title="struct mio::Poll">Poll</a></div><div class="desc docblock-short">Polls for readiness events on all registered values.</div></li><li><div class="item-name"><a class="struct" href="struct.Registry.html" title="struct mio::Registry">Registry</a></div><div class="desc docblock-short">Registers I/O resources.</div></li><li><div class="item-name"><a class="struct" href="struct.Token.html" title="struct mio::Token">Token</a></div><div class="desc docblock-short">Associates readiness events with <a href="./event/trait.Source.html"><code>event::Source</code></a>s.</div></li><li><div class="item-name"><a class="struct" href="struct.Waker.html" title="struct mio::Waker">Waker</a></div><div class="desc docblock-short">Waker allows cross-thread waking of <a href="struct.Poll.html"><code>Poll</code></a>.</div></li></ul></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink