Module Channel.Dup

module Dup: sig .. end

Convenience operators for specifying shell-style dups.

This module provides one prefix operator and a surfeit of infix operators. The prefix operator Channel.Dup.(!%) reveals the integer value of an abstract UNIX file descriptor. The infix operators are for specifying dups, as follows:

Each operator dups its right argument onto its left. This is the reverse of Channel.dup2 and corresponds to the syntax of the Bourne shell.
The < or > indicates the direction of IO: < is for input channels and > for output channels.
Each operator has a prefix sigil that indicates the type of its first argument:
- * is for Channel.gen_in_channels and Channel.gen_out_channels
- % is for integer file descriptors
- / is for in_channels and out_channels
- Use (!%) on Channel.descr to get an int suitable for the % operations.)
Some operators have a suffix sigil that indicates the type of their second arguments:
- & means the second argument is the same type as the first
- *, %, / are as for the first argument
Operators that dup from files indicate the mode in which to open the file:
- < opens a file for reading
- > opens a file for writing, using the mode from Channel.clobber
- >! opens for writing, always clobbering (`Clobber)
- >? opens for writing, never clobbering (`NoClobber)
- >> opens for appending (`Append)
- >>! opens for appending but won't create (`AppendOnly)

Some example dups:

2 %>& 1 redirects error output onto standard output
0 %< "file" redirects input to come from the file
1 %>/ c , where c : out_channel, redirects standard output into the channel
c /<* `Close closes c : in_channel

type dup_arg = Channel.dup_source * Channel.gen_channel

Generalized channels and file descriptor manipulation.

val (!%) : Channel.descr -> int

Get the integer value of an abstract file descriptor.

val ( *<& ) : Channel.gen_in_channel -> Channel.dup_in_source -> dup_arg

Dup a Channel.dup_in_source onto a Channel.gen_in_channel.

val ( *< ) : Channel.gen_in_channel -> string -> dup_arg

Open a file for reading on a Channel.gen_in_channel.

val ( *>& ) : Channel.gen_out_channel -> Channel.dup_out_source -> dup_arg

Dup a Channel.dup_out_source onto a Channel.gen_out_channel.

val ( *> ) : Channel.gen_out_channel -> string -> dup_arg

Open a file for writing on a Channel.gen_out_channel.

val ( *>! ) : Channel.gen_out_channel -> string -> dup_arg

Open a file on a Channel.gen_out_channel, clobbering.

val ( *>? ) : Channel.gen_out_channel -> string -> dup_arg

Open a file on a Channel.gen_out_channel, without clobbering.

val ( *>> ) : Channel.gen_out_channel -> string -> dup_arg

Open a file on a Channel.gen_out_channel, appending.

val ( *>>! ) : Channel.gen_out_channel -> string -> dup_arg

Open a file on a Channel.gen_out_channel, appending, without creating.

val (%<&) : int -> int -> dup_arg

Dup a file descriptor from another file descriptor.

val (%<) : int -> string -> dup_arg

Open a file for reading on a file descriptor.

val (%>&) : int -> int -> dup_arg

Dup a file descriptor from another file descriptor.

val (%>) : int -> string -> dup_arg

Open a file for writing on a file descriptor.

val (%>!) : int -> string -> dup_arg

Open a file on a file descriptor, clobbering.

val (%>?) : int -> string -> dup_arg

Open a file on a file descriptor, without clobbering.

val (%>>) : int -> string -> dup_arg

Open a file on a file descriptor, appending.

val (%>>!) : int -> string -> dup_arg

Open a file on a file descriptor, appending, without creating.

val (/<&) : Pervasives.in_channel -> Pervasives.in_channel -> dup_arg

Dup an in_channel from another in_channel.

val (/<) : Pervasives.in_channel -> string -> dup_arg

Open a file for reading on an in_channel.

val (/>&) : Pervasives.out_channel -> Pervasives.out_channel -> dup_arg

Dup an out_channel from another out_channel.

val (/>) : Pervasives.out_channel -> string -> dup_arg

Open a file for writing on an out_channel.

val (/>!) : Pervasives.out_channel -> string -> dup_arg

Open a file on an out_channel, clobbering.

val (/>?) : Pervasives.out_channel -> string -> dup_arg

Open a file on an out_channel, without clobbering.

val (/>>) : Pervasives.out_channel -> string -> dup_arg

Open a file on an out_channel, appending.

val (/>>!) : Pervasives.out_channel -> string -> dup_arg

Open a file on an out_channel, appending, without creating.

val ( *>% ) : Channel.gen_out_channel -> int -> dup_arg

Dup a Channel.gen_out_channel from a file descriptor.

val ( *>/ ) : Channel.gen_out_channel -> Pervasives.out_channel -> dup_arg

Dup a Channel.gen_out_channel from an out_channel.

val ( %>* ) : int -> Channel.dup_out_source -> dup_arg

Dup a file descriptor from a Channel.dup_out_source.

val (%>/) : int -> Pervasives.out_channel -> dup_arg

Dup a file descriptor from an out_channel.

val ( />* ) : Pervasives.out_channel -> Channel.dup_out_source -> dup_arg

Dup an out_channel from a Channel.dup_out_source.

val (/>%) : Pervasives.out_channel -> int -> dup_arg

Dup an out_channel from a file descriptor.

val ( *<% ) : Channel.gen_in_channel -> int -> dup_arg

Dup a Channel.gen_in_channel from a file descriptor.

val ( *</ ) : Channel.gen_in_channel -> Pervasives.in_channel -> dup_arg

Dup a Channel.gen_in_channel from an in_channel.

val ( %<* ) : int -> Channel.dup_in_source -> dup_arg

Dup a file descriptor from a Channel.dup_in_source.

val (%</) : int -> Pervasives.in_channel -> dup_arg

Dup a file descriptor from an in_channel.

val ( /<* ) : Pervasives.in_channel -> Channel.dup_in_source -> dup_arg

Dup an in_channel from a Channel.dup_in_source.

val (/<%) : Pervasives.in_channel -> int -> dup_arg

Dup an in_channel from a file descriptor.