BasicIO
This object contains factories for scala.sys.process.ProcessIO, which can be used to control the I/O of a scala.sys.process.Process when a scala.sys.process.ProcessBuilder is started with the run
command.
It also contains some helper methods that can be used to in the creation of ProcessIO
.
It is used by other classes in the package in the implementation of various features, but can also be used by client code.
Attributes
- Source
- BasicIO.scala
- Graph
-
- Supertypes
- Self type
-
BasicIO.type
Members list
- no keywords
- final
Value members
Concrete methods
Creates a ProcessIO
from a function String => Unit
.
Creates a ProcessIO
from a function String => Unit
. It can attach the process input to stdin, and it will either send the error stream to stderr, or to a ProcessLogger
.
For example, the ProcessIO
created below will print all normal output while ignoring all error output. No input will be provided.
import scala.sys.process.BasicIO
val errToDevNull = BasicIO(false, println(_), None)
Value parameters
- log
-
An optional
ProcessLogger
to which the output should be sent. IfNone
, output will be sent to stderr. - output
-
A function that will be called with the process output.
- withIn
-
True if the process input should be attached to stdin.
Attributes
- Returns
-
A
ProcessIO
with the characteristics above. - Source
- BasicIO.scala
Creates a ProcessIO
that appends its output to an Appendable
.
Creates a ProcessIO
that appends its output to an Appendable
. It can attach the process input to stdin, and it will either send the error stream to stderr, or to a ProcessLogger
.
For example, the ProcessIO
created by the function below will store the normal output on the buffer provided, and print all error on stderr. The input will be read from stdin.
import scala.sys.process.{BasicIO, ProcessLogger}
val printer = ProcessLogger(println(_))
def appendToBuffer(b: StringBuffer) = BasicIO(true, b, Some(printer))
Value parameters
- buffer
-
An
Appendable
which will receive the process normal output. - log
-
An optional
ProcessLogger
to which the output should be sent. IfNone
, output will be sent to stderr. - withIn
-
True if the process input should be attached to stdin.
Attributes
- Returns
-
A
ProcessIO
with the characteristics above. - Source
- BasicIO.scala
Creates a ProcessIO
from a ProcessLogger
.
Creates a ProcessIO
from a ProcessLogger
. It can attach the process input to stdin.
Value parameters
- log
-
A
ProcessLogger
to receive all output, normal and error. - withIn
-
True if the process input should be attached to stdin.
Attributes
- Returns
-
A
ProcessIO
with the characteristics above. - Source
- BasicIO.scala
Closes a Closeable
without throwing an exception
Copy contents of stdin to the OutputStream
.
Returns a function InputStream => Unit
given an optional ProcessLogger
.
Returns a function InputStream => Unit
given an optional ProcessLogger
. If no logger is passed, the function will send the output to stderr. This function can be used to create a scala.sys.process.ProcessIO.
Value parameters
- log
-
An optional
ProcessLogger
to which the contents of theInputStream
will be sent.
Attributes
- Returns
-
A function
InputStream => Unit
(used by scala.sys.process.ProcessIO) which will send the data to either the providedProcessLogger
or, ifNone
, to stderr. - Source
- BasicIO.scala
Returns a function OutputStream => Unit
that either reads the content from stdin or does nothing but close the stream.
Returns a function OutputStream => Unit
that either reads the content from stdin or does nothing but close the stream. This function can be used by scala.sys.process.ProcessIO.
Attributes
- Source
- BasicIO.scala
Returns a function InputStream => Unit
that appends all data read to the provided Appendable
.
Returns a function InputStream => Unit
that appends all data read to the provided Appendable
. This function can be used to create a scala.sys.process.ProcessIO. The buffer will be appended line by line.
Value parameters
- buffer
-
An
Appendable
such asStringBuilder
orStringBuffer
.
Attributes
- Returns
-
A function
InputStream => Unit
(used by scala.sys.process.ProcessIO which will append all data read from the stream to the buffer. - Source
- BasicIO.scala
Returns a function InputStream => Unit
that will call the passed function with all data read.
Returns a function InputStream => Unit
that will call the passed function with all data read. This function can be used to create a scala.sys.process.ProcessIO. The processLine
function will be called with each line read, and Newline
will be appended after each line.
Value parameters
- processLine
-
A function that will be called with all data read from the stream.
Attributes
- Returns
-
A function
InputStream => Unit
(used by scala.sys.process.ProcessIO which will callprocessLine
with all data read from the stream. - Source
- BasicIO.scala
Calls processLine
with the result of readLine
until the latter returns null
or the current thread is interrupted.
Calls processLine
with the result of readLine
until the latter returns null
or the current thread is interrupted.
Attributes
- Source
- BasicIO.scala
Returns a ProcessIO
connected to stdout and stderr, and, optionally, stdin.
Returns a ProcessIO
connected to stdout and stderr, and, optionally, stdin.
Attributes
- Source
- BasicIO.scala
Returns a ProcessIO
connected to stdout, stderr and the provided in
Send all the input from the stream to stderr, and closes the input stream afterwards.
Send all the input from the stream to stderr, and closes the input stream afterwards.
Attributes
- Source
- BasicIO.scala
Send all the input from the stream to stdout, and closes the input stream afterwards.
Send all the input from the stream to stdout, and closes the input stream afterwards.
Attributes
- Source
- BasicIO.scala
Copy all input from the input stream to the output stream.
Copy all input from the input stream to the output stream. Closes the input stream once it's all read.
Attributes
- Source
- BasicIO.scala
Concrete fields
Size of the buffer used in all the functions that copy data
Used to separate lines in the processFully
function that takes Appendable
.
Used to separate lines in the processFully
function that takes Appendable
.
Attributes
- Source
- BasicIO.scala