BasicIO

scala.sys.process.BasicIO$
object 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
class Object
trait Matchable
class Any
Self type
BasicIO.type

Members list

Concise view

Value members

Concrete methods

def apply(withIn: Boolean, output: String => Unit, log: Option[ProcessLogger]): ProcessIO

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)

Attributes

log

An optional ProcessLogger to which the output should be sent. If None, 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.

Returns:

A ProcessIO with the characteristics above.

Source:
BasicIO.scala
def apply(withIn: Boolean, buffer: Appendable, log: Option[ProcessLogger]): ProcessIO

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))

Attributes

buffer

An Appendable which will receive the process normal output.

log

An optional ProcessLogger to which the output should be sent. If None, output will be sent to stderr.

withIn

True if the process input should be attached to stdin.

Returns:

A ProcessIO with the characteristics above.

Source:
BasicIO.scala
def apply(withIn: Boolean, log: ProcessLogger): ProcessIO

Creates a ProcessIO from a ProcessLogger .

Creates a ProcessIO from a ProcessLogger . It can attach the process input to stdin.

Attributes

log

A ProcessLogger to receive all output, normal and error.

withIn

True if the process input should be attached to stdin.

Returns:

A ProcessIO with the characteristics above.

Source:
BasicIO.scala
def close(c: Closeable): Unit

Closes a Closeable without throwing an exception

Closes a Closeable without throwing an exception

Attributes

Source:
BasicIO.scala
def connectToIn(o: OutputStream): Unit

Copy contents of stdin to the OutputStream.

Copy contents of stdin to the OutputStream.

Attributes

Source:
BasicIO.scala
def getErr(log: Option[ProcessLogger]): InputStream => Unit

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.

Attributes

log

An optional ProcessLogger to which the contents of the InputStream will be sent.

Returns:

A function InputStream => Unit (used by scala.sys.process.ProcessIO) which will send the data to either the provided ProcessLogger or, if None, to stderr.

Source:
BasicIO.scala
def input(connect: Boolean): OutputStream => Unit

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
def processFully(buffer: Appendable): InputStream => Unit

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.

Attributes

buffer

An Appendable such as StringBuilder or StringBuffer.

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
def processFully(processLine: String => Unit): InputStream => Unit

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.

Attributes

processLine

A function that will be called with all data read from the stream.

Returns:

A function InputStream => Unit (used by scala.sys.process.ProcessIO which will call processLine with all data read from the stream.

Source:
BasicIO.scala
def processLinesFully(processLine: String => Unit)(readLine: () => String): Unit

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
def standard(connectInput: Boolean): ProcessIO

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
def standard(in: OutputStream => Unit): ProcessIO

Returns a ProcessIO connected to stdout, stderr and the provided in

Returns a ProcessIO connected to stdout, stderr and the provided in

Attributes

Source:
BasicIO.scala
def toStdErr: InputStream => Unit

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
def toStdOut: InputStream => Unit

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
def transferFully(in: InputStream, out: OutputStream): Unit

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

final val BufferSize: 8192

Size of the buffer used in all the functions that copy data

Size of the buffer used in all the functions that copy data

Attributes

Source:
BasicIO.scala
final val Newline: String

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