View source code
Display the source code in std/process.d from which this page was generated on github.
Report a bug
If you spot a problem with this page, click here to create a Bugzilla issue.
Improve this page
Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone.

std.process.Pipe/pipe - multiple declarations

Function pipe

Creates a unidirectional pipe.

Pipe pipe() @trusted;

Data is written to one end of the pipe and read from the other.

auto p = pipe();
p.writeEnd.writeln("Hello World");
assert(p.readEnd.readln().chomp() == "Hello World");

Pipes can, for example, be used for interprocess communication by spawning a new process and passing one end of the pipe to the child, while the parent uses the other end. (See also pipeProcess and pipeShell for an easier way of doing this.)

// Use cURL to download the front page, pipe its
// output to grep to extract a list of links to ZIP files,
// and write the list to the file "D downloads.txt":
auto p = pipe();
auto outFile = File("D downloads.txt", "w");
auto cpid = spawnProcess(["curl", ""],
                         stdin, p.writeEnd);
scope(exit) wait(cpid);
auto gpid = spawnProcess(["grep", "-o", `http://\S*\.zip`],
                         p.readEnd, outFile);
scope(exit) wait(gpid);


A Pipe object that corresponds to the created pipe.


StdioException on failure.

Struct Pipe

An interface to a pipe created by the pipe function.

struct Pipe ;


readEnd[get] FileThe read end of the pipe.
writeEnd[get] FileThe write end of the pipe.


close () Closes both ends of the pipe.


Lars Tandle Kyllingstad, Steven Schveighoffer, Vladimir Panteleev


Boost License 1.0.