27 lines
No EOL
6.2 KiB
HTML
27 lines
No EOL
6.2 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="A generic event source wrapping an IO objects or file descriptor"><title>cosmic::cctk::sctk::reexports::calloop::generic - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../../../static.files/rustdoc-aa0817cf.css"><meta name="rustdoc-vars" data-root-path="../../../../../../" data-static-root-path="../../../../../../static.files/" data-current-crate="cosmic" data-themes="" data-resource-suffix="" data-rustdoc-version="1.90.0-nightly (3048886e5 2025-07-30)" data-channel="nightly" data-search-js="search-fa3e91e5.js" data-settings-js="settings-5514c975.js" ><script src="../../../../../../static.files/storage-68b7e25d.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../../../../static.files/main-eebb9057.js"></script><noscript><link rel="stylesheet" href="../../../../../../static.files/noscript-32bb7600.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../../../../cosmic/index.html">cosmic</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module generic</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In cosmic::<wbr>cctk::<wbr>sctk::<wbr>reexports::<wbr>calloop</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../../../../index.html">cosmic</a>::<wbr><a href="../../../../index.html">cctk</a>::<wbr><a href="../../../index.html">sctk</a>::<wbr><a href="../../index.html">reexports</a>::<wbr><a href="../index.html">calloop</a></div><h1>Module <span>generic</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"></span></div><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>wayland</code> and Linux</strong> only.</div></span><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A generic event source wrapping an IO objects or file descriptor</p>
|
||
<p>You can use this general purpose adapter around file-descriptor backed objects to
|
||
insert into an <a href="../struct.EventLoop.html" title="struct cosmic::cctk::sctk::reexports::calloop::EventLoop"><code>EventLoop</code></a>.</p>
|
||
<p>The event generated by this <a href="struct.Generic.html" title="struct cosmic::cctk::sctk::reexports::calloop::generic::Generic"><code>Generic</code></a> event source are the <a href="../struct.Readiness.html" title="struct cosmic::cctk::sctk::reexports::calloop::Readiness"><code>Readiness</code></a>
|
||
notification itself, and the monitored object is provided to your callback as the second
|
||
argument.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>calloop::{generic::Generic, Interest, Mode, PostAction};
|
||
|
||
handle.insert_source(
|
||
<span class="comment">// wrap your IO object in a Generic, here we register for read readiness
|
||
// in level-triggering mode
|
||
</span>Generic::new(io_object, Interest::READ, Mode::Level),
|
||
|readiness, io_object, shared_data| {
|
||
<span class="comment">// The first argument of the callback is a Readiness
|
||
// The second is a &mut reference to your object
|
||
|
||
// your callback needs to return a Result<PostAction, std::io::Error>
|
||
// if it returns an error, the event loop will consider this event
|
||
// event source as erroring and report it to the user.
|
||
</span><span class="prelude-val">Ok</span>(PostAction::Continue)
|
||
}
|
||
);</code></pre></div>
|
||
<p>It can also help you implementing your own event sources: just have
|
||
these <code>Generic<_></code> as fields of your event source, and delegate the
|
||
<a href="../trait.EventSource.html" title="trait cosmic::cctk::sctk::reexports::calloop::EventSource"><code>EventSource</code></a> implementation to them.</p>
|
||
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.FdWrapper.html" title="struct cosmic::cctk::sctk::reexports::calloop::generic::FdWrapper">FdWrapper</a></dt><dd>Wrapper to use a type implementing <code>AsRawFd</code> but not <code>AsFd</code> with <code>Generic</code></dd><dt><a class="struct" href="struct.Generic.html" title="struct cosmic::cctk::sctk::reexports::calloop::generic::Generic">Generic</a></dt><dd>A generic event source wrapping a FD-backed type</dd><dt><a class="struct" href="struct.NoIoDrop.html" title="struct cosmic::cctk::sctk::reexports::calloop::generic::NoIoDrop">NoIo<wbr>Drop</a></dt><dd>A wrapper around a type that doesn’t expose it mutably safely.</dd></dl></section></div></main></body></html> |