55 lines
11 KiB
HTML
55 lines
11 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="Experimental new types and traits to replace the `Raw` family of types and traits."><meta name="keywords" content="rust, rustlang, rust-lang, io_lifetimes"><title>io_lifetimes - 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="../crates.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 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">☰</button><a class="sidebar-logo" href="../io_lifetimes/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="../io_lifetimes/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate io_lifetimes</a></h2><div class="sidebar-elems"><div class="block"><ul><li class="version">Version 1.0.3</li><li><a id="all-types" href="all.html">All Items</a></li></ul></div><section><div class="block"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div></section></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../io_lifetimes/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">Crate <a class="mod" href="#">io_lifetimes</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/io_lifetimes/lib.rs.html#1-187">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Experimental new types and traits to replace the <code>Raw</code> family of types and
|
||
traits.</p>
|
||
<p>This API has much conceptual similarity with the <code>Raw</code> API, but introduces
|
||
explicit concepts of ownership and borrowing:</p>
|
||
<div><table><thead><tr><th><code>Raw</code> API</th><th>This experimental API</th></tr></thead><tbody>
|
||
<tr><td><code>Raw*</code></td><td><code>Borrowed*</code> and <code>Owned*</code></td></tr>
|
||
<tr><td><code>AsRaw*</code></td><td><code>As*</code></td></tr>
|
||
<tr><td><code>IntoRaw*</code></td><td><code>Into*</code></td></tr>
|
||
<tr><td><code>FromRaw*</code></td><td><code>From*</code></td></tr>
|
||
</tbody></table>
|
||
</div>
|
||
<p>This gives it several advantages:</p>
|
||
<ul>
|
||
<li>
|
||
<p>Less <code>unsafe</code> in user code!</p>
|
||
</li>
|
||
<li>
|
||
<p>Easier to understand ownership.</p>
|
||
</li>
|
||
<li>
|
||
<p>It avoids the inconsistency where <code>AsRawFd</code> and <code>IntoRawFd</code> return
|
||
<code>RawFd</code> values that users ought to be able to trust, but aren’t unsafe,
|
||
so it’s possible to fail to uphold this trust in purely safe Rust.</p>
|
||
</li>
|
||
<li>
|
||
<p>It enables a number of safe and portable convenience features, such as
|
||
<a href="trait.AsFilelike.html#tymethod.as_filelike_view">safe typed views</a> and <a href="trait.FromFilelike.html#tymethod.from_into_filelike">from+into conversions</a>.</p>
|
||
</li>
|
||
</ul>
|
||
</div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="example_ffi/index.html" title="io_lifetimes::example_ffi mod">example_ffi</a></div><div class="item-right docblock-short"><p>This is just a sample of what FFI using this crate can look like.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="raw/index.html" title="io_lifetimes::raw mod">raw</a></div><div class="item-right docblock-short"><p>Portability abstractions over <code>Raw*</code>.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="views/index.html" title="io_lifetimes::views mod">views</a></div><div class="item-right docblock-short"><p>Typed views using temporary objects.</p>
|
||
</div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.BorrowedFd.html" title="io_lifetimes::BorrowedFd struct">BorrowedFd</a></div><div class="item-right docblock-short"><p>A borrowed file descriptor.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.OwnedFd.html" title="io_lifetimes::OwnedFd struct">OwnedFd</a></div><div class="item-right docblock-short"><p>An owned file descriptor.</p>
|
||
</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.AsFd.html" title="io_lifetimes::AsFd trait">AsFd</a></div><div class="item-right docblock-short"><p>A trait to borrow the file descriptor from an underlying object.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.AsFilelike.html" title="io_lifetimes::AsFilelike trait">AsFilelike</a></div><div class="item-right docblock-short"><p>A portable trait to borrow a reference from an underlying filelike object.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.AsSocketlike.html" title="io_lifetimes::AsSocketlike trait">AsSocketlike</a></div><div class="item-right docblock-short"><p>A portable trait to borrow a reference from an underlying socketlike
|
||
object.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.FromFd.html" title="io_lifetimes::FromFd trait">FromFd</a></div><div class="item-right docblock-short"><p>A trait to express the ability to construct an object from a file
|
||
descriptor.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.FromFilelike.html" title="io_lifetimes::FromFilelike trait">FromFilelike</a></div><div class="item-right docblock-short"><p>A portable trait to express the ability to construct an object from a
|
||
filelike object.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.FromSocketlike.html" title="io_lifetimes::FromSocketlike trait">FromSocketlike</a></div><div class="item-right docblock-short"><p>A portable trait to express the ability to construct an object from a
|
||
socketlike object.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.IntoFd.html" title="io_lifetimes::IntoFd trait">IntoFd</a><span class="stab deprecated" title="">Deprecated</span></div><div class="item-right docblock-short"><p>A trait to express the ability to consume an object and acquire ownership
|
||
of its file descriptor.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.IntoFilelike.html" title="io_lifetimes::IntoFilelike trait">IntoFilelike</a></div><div class="item-right docblock-short"><p>A portable trait to express the ability to consume an object and acquire
|
||
ownership of its filelike object.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.IntoSocketlike.html" title="io_lifetimes::IntoSocketlike trait">IntoSocketlike</a></div><div class="item-right docblock-short"><p>A portable trait to express the ability to consume an object and acquire
|
||
ownership of its socketlike object.</p>
|
||
</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.BorrowedFilelike.html" title="io_lifetimes::BorrowedFilelike type">BorrowedFilelike</a></div><div class="item-right docblock-short"><p>A reference to a filelike object.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.BorrowedSocketlike.html" title="io_lifetimes::BorrowedSocketlike type">BorrowedSocketlike</a></div><div class="item-right docblock-short"><p>A reference to a socketlike object.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.OwnedFilelike.html" title="io_lifetimes::OwnedFilelike type">OwnedFilelike</a></div><div class="item-right docblock-short"><p>An owned filelike object.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.OwnedSocketlike.html" title="io_lifetimes::OwnedSocketlike type">OwnedSocketlike</a></div><div class="item-right docblock-short"><p>An owned socketlike object.</p>
|
||
</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="io_lifetimes" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |