30 lines
5.9 KiB
HTML
30 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="Creates a new anonymous Unix pipe."><title>pipe in tokio::net::unix::pipe - 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"href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="tokio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.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]--><rustdoc-topbar><h2><a href="#">pipe</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../../tokio/index.html">tokio</a><span class="version">1.49.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">pipe</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#errors" title="Errors">Errors</a></li><li><a href="#examples" title="Examples">Examples</a></li><li><a href="#panics" title="Panics">Panics</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In tokio::<wbr>net::<wbr>unix::<wbr>pipe</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../../index.html">tokio</a>::<wbr><a href="../../index.html">net</a>::<wbr><a href="../index.html">unix</a>::<wbr><a href="index.html">pipe</a></div><h1>Function <span class="fn">pipe</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../../src/tokio/net/unix/pipe.rs.html#67-70">Source</a> </span></div><pre class="rust item-decl"><code>pub fn pipe() -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><(<a class="struct" href="struct.Sender.html" title="struct tokio::net::unix::pipe::Sender">Sender</a>, <a class="struct" href="struct.Receiver.html" title="struct tokio::net::unix::pipe::Receiver">Receiver</a>)></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Creates a new anonymous Unix pipe.</p>
|
|
<p>This function will open a new pipe and associate both pipe ends with the default
|
|
event loop.</p>
|
|
<p>If you need to create a pipe for communication with a spawned process, you can
|
|
use <a href="https://doc.rust-lang.org/1.93.1/std/process/struct.Stdio.html#method.piped" title="associated function std::process::Stdio::piped"><code>Stdio::piped()</code></a> instead.</p>
|
|
<h2 id="errors"><a class="doc-anchor" href="#errors">§</a>Errors</h2>
|
|
<p>If creating a pipe fails, this function will return with the related OS error.</p>
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
|
<p>Create a pipe and pass the writing end to a spawned process.</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::unix::pipe;
|
|
<span class="kw">use </span>tokio::process::Command;
|
|
|
|
<span class="kw">let </span>(tx, <span class="kw-2">mut </span>rx) = pipe::pipe()<span class="question-mark">?</span>;
|
|
<span class="kw">let </span><span class="kw-2">mut </span>buffer = String::new();
|
|
|
|
<span class="kw">let </span>status = Command::new(<span class="string">"echo"</span>)
|
|
.arg(<span class="string">"Hello, world!"</span>)
|
|
.stdout(tx.into_blocking_fd()<span class="question-mark">?</span>)
|
|
.status();
|
|
rx.read_to_string(<span class="kw-2">&mut </span>buffer).<span class="kw">await</span><span class="question-mark">?</span>;
|
|
|
|
<span class="macro">assert!</span>(status.<span class="kw">await</span><span class="question-mark">?</span>.success());
|
|
<span class="macro">assert_eq!</span>(buffer, <span class="string">"Hello, world!\n"</span>);</code></pre></div><h2 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h2>
|
|
<p>This function panics if it is not called from within a runtime with
|
|
IO enabled.</p>
|
|
<p>The runtime is usually set implicitly when this function is called
|
|
from a future driven by a tokio runtime, otherwise runtime can be set
|
|
explicitly with <a href="../../../runtime/struct.Runtime.html#method.enter" title="method tokio::runtime::Runtime::enter"><code>Runtime::enter</code></a> function.</p>
|
|
</div></details></section></div></main></body></html> |