17 lines
5.9 KiB
HTML
17 lines
5.9 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="`vmsplice(fd, bufs, flags)`—Transfer data between memory and a pipe."><meta name="keywords" content="rust, rustlang, rust-lang, vmsplice"><title>vmsplice in rustix::io - 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 fn"><!--[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><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</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">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">vmsplice</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/pipe.rs.html#124-130">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 fn"><code>pub unsafe fn vmsplice<PipeFd: <a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>>(<br> fd: PipeFd,<br> bufs: &[<a class="struct" href="struct.IoSliceRaw.html" title="struct rustix::io::IoSliceRaw">IoSliceRaw</a><'_>],<br> flags: <a class="struct" href="struct.SpliceFlags.html" title="struct rustix::io::SpliceFlags">SpliceFlags</a><br>) -> <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.usize.html">usize</a>></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>vmsplice(fd, bufs, flags)</code>—Transfer data between memory and a pipe.</p>
|
||
<p>If <code>fd</code> is the write end of the pipe,
|
||
the function maps the memory pointer at by <code>bufs</code> to the pipe.</p>
|
||
<p>If <code>fd</code> is the read end of the pipe,
|
||
the function writes data from the pipe to said memory.</p>
|
||
<h2 id="safety"><a href="#safety">Safety</a></h2>
|
||
<p>If the memory must not be mutated (such as when <code>bufs</code> were originally immutable slices),
|
||
it is up to the caller to ensure that the write end of the pipe is placed in <code>fd</code>.</p>
|
||
<p>Additionally if <code>SpliceFlags::GIFT</code> is set, the caller must also ensure
|
||
that the contents of <code>bufs</code> in never modified following the call,
|
||
and that all of the pointers in <code>bufs</code> are page aligned,
|
||
and the lengths are multiples of a page size in bytes.</p>
|
||
<h2 id="references"><a href="#references">References</a></h2>
|
||
<ul>
|
||
<li><a href="https://man7.org/linux/man-pages/man2/vmsplice.2.html">Linux</a></li>
|
||
</ul>
|
||
</div></details></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> |