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.
- Source
- BasicIO.scala
- Alphabetic
- By Inheritance
- BasicIO
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
Test two objects for inequality.
Test two objects for inequality.
- returns
true
if !(this == that), false otherwise.
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
Equivalent to
x.hashCode
except for boxed numeric types andnull
.Equivalent to
x.hashCode
except for boxed numeric types andnull
. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. Fornull
returns a hashcode wherenull.hashCode
throws aNullPointerException
.- returns
a hash value consistent with ==
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.- returns
true
if the receiver object is equivalent to the argument;false
otherwise.
- Definition Classes
- AnyRef → Any
-
final
val
BufferSize: Int(8192)
Size of the buffer used in all the functions that copy data
-
final
val
Newline: String
Used to separate lines in the
processFully
function that takesAppendable
. -
def
apply(withIn: Boolean, log: ProcessLogger): ProcessIO
Creates a
ProcessIO
from aProcessLogger
.Creates a
ProcessIO
from aProcessLogger
. It can attach the process input to stdin.- withIn
True if the process input should be attached to stdin.
- log
A
ProcessLogger
to receive all output, normal and error.- returns
A
ProcessIO
with the characteristics above.
-
def
apply(withIn: Boolean, buffer: StringBuffer, log: Option[ProcessLogger]): ProcessIO
Creates a
ProcessIO
that appends its output to aStringBuffer
.Creates a
ProcessIO
that appends its output to aStringBuffer
. It can attach the process input to stdin, and it will either send the error stream to stderr, or to aProcessLogger
.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))
- withIn
True if the process input should be attached to stdin.
- buffer
A
StringBuffer
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.- returns
A
ProcessIO
with the characteristics above.
-
def
apply(withIn: Boolean, output: (String) ⇒ Unit, log: Option[ProcessLogger]): ProcessIO
Creates a
ProcessIO
from a functionString => Unit
.Creates a
ProcessIO
from a functionString => Unit
. It can attach the process input to stdin, and it will either send the error stream to stderr, or to aProcessLogger
.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)
- withIn
True if the process input should be attached to stdin.
- output
A function that will be called with the process output.
- log
An optional
ProcessLogger
to which the output should be sent. IfNone
, output will be sent to stderr.- returns
A
ProcessIO
with the characteristics above.
-
final
def
asInstanceOf[T0]: T0
Cast the receiver object to be of type
T0
.Cast the receiver object to be of type
T0
.Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression
1.asInstanceOf[String]
will throw aClassCastException
at runtime, while the expressionList(1).asInstanceOf[List[String]]
will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.- returns
the receiver object.
- Definition Classes
- Any
- Exceptions thrown
ClassCastException
if the receiver object is not an instance of the erasure of typeT0
.
-
def
clone(): AnyRef
Create a copy of the receiver object.
-
def
close(c: Closeable): Unit
Closes a
Closeable
without throwing an exception -
def
connectToIn(o: OutputStream): Unit
Copy contents of stdin to the
OutputStream
. -
final
def
eq(arg0: AnyRef): Boolean
Tests whether the argument (
that
) is a reference to the receiver object (this
).Tests whether the argument (
that
) is a reference to the receiver object (this
).The
eq
method implements an equivalence relation on non-null instances ofAnyRef
, and has three additional properties:- It is consistent: for any non-null instances
x
andy
of typeAnyRef
, multiple invocations ofx.eq(y)
consistently returnstrue
or consistently returnsfalse
. - For any non-null instance
x
of typeAnyRef
,x.eq(null)
andnull.eq(x)
returnsfalse
. null.eq(null)
returnstrue
.
When overriding the
equals
orhashCode
methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2
), they should be equal to each other (o1 == o2
) and they should hash to the same value (o1.hashCode == o2.hashCode
).- returns
true
if the argument is a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
- It is consistent: for any non-null instances
-
def
equals(arg0: Any): Boolean
The equality method for reference types.
-
def
finalize(): Unit
Called by the garbage collector on the receiver object when there are no more references to the object.
Called by the garbage collector on the receiver object when there are no more references to the object.
The details of when and if the
finalize
method is invoked, as well as the interaction betweenfinalize
and non-local returns and exceptions, are all platform dependent.- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- Note
not specified by SLS as a member of AnyRef
-
final
def
getClass(): Class[_]
Returns the runtime class representation of the object.
-
def
getErr(log: Option[ProcessLogger]): (InputStream) ⇒ Unit
Returns a function
InputStream => Unit
given an optionalProcessLogger
.Returns a function
InputStream => Unit
given an optionalProcessLogger
. 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.- log
An optional
ProcessLogger
to which the contents of theInputStream
will be sent.- returns
A function
InputStream => Unit
(used by scala.sys.process.ProcessIO) which will send the data to either the providedProcessLogger
or, ifNone
, to stderr.
-
def
hashCode(): Int
The hashCode method for reference types.
-
def
input(connect: Boolean): (OutputStream) ⇒ Unit
Returns a function
OutputStream => Unit
that either reads the content from stdin or does nothing.Returns a function
OutputStream => Unit
that either reads the content from stdin or does nothing. This function can be used by scala.sys.process.ProcessIO. -
final
def
isInstanceOf[T0]: Boolean
Test whether the dynamic type of the receiver object is
T0
.Test whether the dynamic type of the receiver object is
T0
.Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression
1.isInstanceOf[String]
will returnfalse
, while the expressionList(1).isInstanceOf[List[String]]
will returntrue
. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.- returns
true
if the receiver object is an instance of erasure of typeT0
;false
otherwise.
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
Equivalent to
!(this eq that)
.Equivalent to
!(this eq that)
.- returns
true
if the argument is not a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up a single thread that is waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
-
final
def
notifyAll(): Unit
Wakes up all threads that are waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
-
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. TheprocessLine
function will be called with each line read, andNewline
will be appended after each line.- 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 callprocessLine
with all data read from the stream.
-
def
processFully(buffer: Appendable): (InputStream) ⇒ Unit
Returns a function
InputStream => Unit
that appends all data read to the providedAppendable
.Returns a function
InputStream => Unit
that appends all data read to the providedAppendable
. This function can be used to create a scala.sys.process.ProcessIO. The buffer will be appended line by line.- buffer
An
Appendable
such asStringBuilder
orStringBuffer
.- returns
A function
InputStream => Unit
(used by scala.sys.process.ProcessIO which will append all data read from the stream to the buffer.
-
def
processLinesFully(processLine: (String) ⇒ Unit)(readLine: () ⇒ String): Unit
Calls
processLine
with the result ofreadLine
until the latter returnsnull
or the current thread is interrupted. -
def
standard(in: (OutputStream) ⇒ Unit): ProcessIO
Returns a
ProcessIO
connected to stdout, stderr and the providedin
-
def
standard(connectInput: Boolean): ProcessIO
Returns a
ProcessIO
connected to stdout and stderr, and, optionally, stdin. -
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toStdErr: (InputStream) ⇒ Unit
Send all the input from the stream to stderr, and closes the input stream afterwards.
-
def
toStdOut: (InputStream) ⇒ Unit
Send all the input from the stream to stdout, and closes the input stream afterwards.
-
def
toString(): String
Creates a String representation of this object.
Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.
- returns
a String representation of the object.
- Definition Classes
- AnyRef → Any
-
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.
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- final def wait(arg0: Long): Unit
This is the documentation for the Scala standard library.
Package structure
The scala package contains core types like
Int
,Float
,Array
orOption
which are accessible in all Scala compilation units without explicit qualification or imports.Notable packages include:
scala.collection
and its sub-packages contain Scala's collections frameworkscala.collection.immutable
- Immutable, sequential data-structures such asVector
,List
,Range
,HashMap
orHashSet
scala.collection.mutable
- Mutable, sequential data-structures such asArrayBuffer
,StringBuilder
,HashMap
orHashSet
scala.collection.concurrent
- Mutable, concurrent data-structures such asTrieMap
scala.collection.parallel.immutable
- Immutable, parallel data-structures such asParVector
,ParRange
,ParHashMap
orParHashSet
scala.collection.parallel.mutable
- Mutable, parallel data-structures such asParArray
,ParHashMap
,ParTrieMap
orParHashSet
scala.concurrent
- Primitives for concurrent programming such asFutures
andPromises
scala.io
- Input and output operationsscala.math
- Basic math functions and additional numeric types likeBigInt
andBigDecimal
scala.sys
- Interaction with other processes and the operating systemscala.util.matching
- Regular expressionsOther packages exist. See the complete list on the right.
Additional parts of the standard library are shipped as separate libraries. These include:
scala.reflect
- Scala's reflection API (scala-reflect.jar)scala.xml
- XML parsing, manipulation, and serialization (scala-xml.jar)scala.swing
- A convenient wrapper around Java's GUI framework called Swing (scala-swing.jar)scala.util.parsing
- Parser combinators (scala-parser-combinators.jar)Automatic imports
Identifiers in the scala package and the
scala.Predef
object are always in scope by default.Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example,
List
is an alias forscala.collection.immutable.List
.Other aliases refer to classes provided by the underlying platform. For example, on the JVM,
String
is an alias forjava.lang.String
.