Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Bare-bones documentation for type IO::Pipe
  • Loading branch information
moritz committed Jul 6, 2015
1 parent 0178965 commit 39d9449
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions lib/Type/IO/Pipe.pod
@@ -0,0 +1,24 @@
=begin pod
=TITLE class IO::Pipe
=SUBTITLE Buffered FIFO / Pipe
class IO::Pipe does IO::Handle { ... }
An C<IO::Pipe> object closely corresponds to a UNIX pipe. It has one end where
it consumes string or binary data, and another where it reproduces the same
data. It is buffered, so that a write without a read doesn't immediately
block.
Pipes can be easily constructed with L<sub run and Proc.new|/type/Proc>.
=head1 Methods
=head2 method proc
method prodc(IO::Pipe:) returns Proc:D
Returns the L<Proc> object from which the pipe originates.
=end pod

0 comments on commit 39d9449

Please sign in to comment.