20 lines
15 KiB
HTML
20 lines
15 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 trait for data stored within an `Epoll` instance."><meta name="keywords" content="rust, rustlang, rust-lang, Context"><title>Context in rustix::io::epoll - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><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="../../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc trait"><!--[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">☰</button><a class="sidebar-logo" href="../../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Context</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#required-associated-types">Required Associated Types</a></h3><ul><li><a href="#associatedtype.Data">Data</a></li><li><a href="#associatedtype.Target">Target</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><ul><li><a href="#tymethod.acquire">acquire</a></li><li><a href="#tymethod.decode">decode</a></li><li><a href="#tymethod.encode">encode</a></li><li><a href="#tymethod.release">release</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In rustix::io::epoll</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../rustix/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Trait <a href="../../index.html">rustix</a>::<wbr><a href="../index.html">io</a>::<wbr><a href="index.html">epoll</a>::<wbr><a class="trait" href="#">Context</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../../src/rustix/io/context.rs.html#50-74">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust trait"><code>pub trait Context {
|
||
type <a href="#associatedtype.Data" class="associatedtype">Data</a>;
|
||
type <a href="#associatedtype.Target" class="associatedtype">Target</a>: <a class="trait" href="../../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>;
|
||
|
||
fn <a href="#tymethod.acquire" class="fnname">acquire</a><'call>(&self, data: Self::<a class="associatedtype" href="trait.Context.html#associatedtype.Data" title="type rustix::io::epoll::Context::Data">Data</a>) -> <a class="struct" href="struct.Ref.html" title="struct rustix::io::epoll::Ref">Ref</a><'call, Self::<a class="associatedtype" href="trait.Context.html#associatedtype.Target" title="type rustix::io::epoll::Context::Target">Target</a>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.encode" class="fnname">encode</a>(&self, target: <a class="struct" href="struct.Ref.html" title="struct rustix::io::epoll::Ref">Ref</a><'_, Self::<a class="associatedtype" href="trait.Context.html#associatedtype.Target" title="type rustix::io::epoll::Context::Target">Target</a>>) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u64.html">u64</a>;
|
||
<span class="item-spacer"></span> unsafe fn <a href="#tymethod.decode" class="fnname">decode</a><'call>(&self, raw: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u64.html">u64</a>) -> <a class="struct" href="struct.Ref.html" title="struct rustix::io::epoll::Ref">Ref</a><'call, Self::<a class="associatedtype" href="trait.Context.html#associatedtype.Target" title="type rustix::io::epoll::Context::Target">Target</a>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.release" class="fnname">release</a>(&self, target: <a class="struct" href="struct.Ref.html" title="struct rustix::io::epoll::Ref">Ref</a><'_, Self::<a class="associatedtype" href="trait.Context.html#associatedtype.Target" title="type rustix::io::epoll::Context::Target">Target</a>>) -> Self::<a class="associatedtype" href="trait.Context.html#associatedtype.Data" title="type rustix::io::epoll::Context::Data">Data</a>;
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A trait for data stored within an <a href="struct.Epoll.html"><code>Epoll</code></a> instance.</p>
|
||
</div></details><h2 id="required-associated-types" class="small-section-header">Required Associated Types<a href="#required-associated-types" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Data" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/rustix/io/context.rs.html#52">source</a></div><h4 class="code-header">type <a href="#associatedtype.Data" class="associatedtype">Data</a></h4></div></summary><div class="docblock"><p>The type of an element owned by this context.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="associatedtype.Target" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/rustix/io/context.rs.html#55">source</a></div><h4 class="code-header">type <a href="#associatedtype.Target" class="associatedtype">Target</a>: <a class="trait" href="../../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a></h4></div></summary><div class="docblock"><p>The type of a value used to refer to an element owned by this context.</p>
|
||
</div></details></div><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.acquire" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/rustix/io/context.rs.html#58">source</a></div><h4 class="code-header">fn <a href="#tymethod.acquire" class="fnname">acquire</a><'call>(&self, data: Self::<a class="associatedtype" href="trait.Context.html#associatedtype.Data" title="type rustix::io::epoll::Context::Data">Data</a>) -> <a class="struct" href="struct.Ref.html" title="struct rustix::io::epoll::Ref">Ref</a><'call, Self::<a class="associatedtype" href="trait.Context.html#associatedtype.Target" title="type rustix::io::epoll::Context::Target">Target</a>></h4></div></summary><div class="docblock"><p>Assume ownership of <code>data</code>, and returning a <code>Target</code>.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.encode" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/rustix/io/context.rs.html#62">source</a></div><h4 class="code-header">fn <a href="#tymethod.encode" class="fnname">encode</a>(&self, target: <a class="struct" href="struct.Ref.html" title="struct rustix::io::epoll::Ref">Ref</a><'_, Self::<a class="associatedtype" href="trait.Context.html#associatedtype.Target" title="type rustix::io::epoll::Context::Target">Target</a>>) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u64.html">u64</a></h4></div></summary><div class="docblock"><p>Encode <code>target</code> as a <code>u64</code>. The only requirement on this value is that
|
||
it be decodable by <code>decode</code>.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.decode" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/rustix/io/context.rs.html#70">source</a></div><h4 class="code-header">unsafe fn <a href="#tymethod.decode" class="fnname">decode</a><'call>(&self, raw: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u64.html">u64</a>) -> <a class="struct" href="struct.Ref.html" title="struct rustix::io::epoll::Ref">Ref</a><'call, Self::<a class="associatedtype" href="trait.Context.html#associatedtype.Target" title="type rustix::io::epoll::Context::Target">Target</a>></h4></div></summary><div class="docblock"><p>Decode <code>raw</code>, which is a value encoded by <code>encode</code>, into a <code>Target</code>.</p>
|
||
<h5 id="safety"><a href="#safety">Safety</a></h5>
|
||
<p><code>raw</code> must be a <code>u64</code> value returned from <code>encode</code>, from the same
|
||
context, and within the context’s lifetime.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.release" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/rustix/io/context.rs.html#73">source</a></div><h4 class="code-header">fn <a href="#tymethod.release" class="fnname">release</a>(&self, target: <a class="struct" href="struct.Ref.html" title="struct rustix::io::epoll::Ref">Ref</a><'_, Self::<a class="associatedtype" href="trait.Context.html#associatedtype.Target" title="type rustix::io::epoll::Context::Target">Target</a>>) -> Self::<a class="associatedtype" href="trait.Context.html#associatedtype.Data" title="type rustix::io::epoll::Context::Data">Data</a></h4></div></summary><div class="docblock"><p>Release ownership of the value referred to by <code>target</code> and return it.</p>
|
||
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Context-for-Borrowing%3C%27a%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../../src/rustix/io/context.rs.html#81-104">source</a></span><a href="#impl-Context-for-Borrowing%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="trait.Context.html" title="trait rustix::io::epoll::Context">Context</a> for <a class="struct" href="struct.Borrowing.html" title="struct rustix::io::epoll::Borrowing">Borrowing</a><'a></h3></section></summary><div class="impl-items"><section id="associatedtype.Data-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Data-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Data" class="associatedtype">Data</a> = <a class="struct" href="../../fd/struct.BorrowedFd.html" title="struct rustix::fd::BorrowedFd">BorrowedFd</a><'a></h4></section><section id="associatedtype.Target-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Target-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Target" class="associatedtype">Target</a> = <a class="struct" href="../../fd/struct.BorrowedFd.html" title="struct rustix::fd::BorrowedFd">BorrowedFd</a><'a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Context-for-Owning%3C%27context%2C%20T%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../../src/rustix/io/context.rs.html#129-163">source</a></span><a href="#impl-Context-for-Owning%3C%27context%2C%20T%3E" class="anchor"></a><h3 class="code-header in-band">impl<'context, T: <a class="trait" href="../../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../../fd/struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a>> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="../../fd/struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a>>> <a class="trait" href="trait.Context.html" title="trait rustix::io::epoll::Context">Context</a> for <a class="struct" href="struct.Owning.html" title="struct rustix::io::epoll::Owning">Owning</a><'context, T></h3></section></summary><div class="impl-items"><section id="associatedtype.Data-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Data-2" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Data" class="associatedtype">Data</a> = T</h4></section><section id="associatedtype.Target-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Target-2" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Target" class="associatedtype">Target</a> = <a class="struct" href="../../fd/struct.BorrowedFd.html" title="struct rustix::fd::BorrowedFd">BorrowedFd</a><'context></h4></section></div></details></div><script type="text/javascript" src="../../../implementors/rustix/io/context/trait.Context.js" data-ignore-extern-crates="" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |