Object scala.io.Source
Companion class Source
object Source
Value Members
final def !=(arg0: Any): Boolean
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 and null
. 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. For null
returns a hashcode where null.hashCode
throws a NullPointerException
.
- returns
a hash value consistent with ==
- Definition Classes
- AnyRef → Any
final def ==(arg0: Any): Boolean
The expression x == that
is equivalent to if (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
val DefaultBufSize: Int
final def asInstanceOf[T0]: 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 a ClassCastException
at runtime, while the expression List(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.
The default implementation of the clone
method is platform dependent.
- returns
a copy of the receiver object.
def createBufferedSource(inputStream: InputStream, bufferSize: Int = DefaultBufSize, reset: () ⇒ Source = null, close: () ⇒ Unit = null)(implicit codec: Codec): BufferedSource
Reads data from inputStream with a buffered reader, using the encoding in implicit parameter codec.
- inputStream
the input stream from which to read
- bufferSize
buffer size (defaults to Source.DefaultBufSize)
- reset
a () => Source which resets the stream (if unset, reset() will throw an Exception)
- close
a () => Unit method which closes the stream (if unset, close() will do nothing)
- codec
(implicit) a scala.io.Codec specifying behavior (defaults to Codec.default)
- returns
the buffered source
final def eq(arg0: AnyRef): Boolean
Tests whether the argument (that
) is a reference to the receiver object (this
).
The eq
method implements an equivalence relation on non-null instances of AnyRef
, and has three additional properties:
-
It is consistent: for any non-null instances
x
and y
of type AnyRef
, multiple invocations of x.eq(y)
consistently returns true
or consistently returns false
.For any non-null instance x
of type AnyRef
, x.eq(null)
and null.eq(x)
returns false
.
null.eq(null)
returns true
. When overriding the equals
or hashCode
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
def equals(arg0: Any): Boolean
The equality method for reference types. Default implementation delegates to eq
.
See also equals
in scala.Any.
- returns
true
if the receiver object is equivalent to the argument;false
otherwise.
- Definition Classes
- AnyRef → Any
def finalize(): Unit
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 between finalize
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
def fromBytes(bytes: Array[Byte], enc: String): Source
def fromBytes(bytes: Array[Byte])(implicit codec: Codec): Source
Create a Source
from array of bytes, decoding the bytes according to codec.
- returns
the created
Source
instance.
def fromChar(c: Char): Source
def fromChars(chars: Array[Char]): Source
def fromFile(file: File, bufferSize: Int)(implicit codec: Codec): BufferedSource
Creates Source from file
, using given character encoding, setting its description to filename. Input is buffered in a buffer of size bufferSize
.
def fromFile(file: File, enc: String, bufferSize: Int): BufferedSource
def fromFile(file: File, enc: String): BufferedSource
def fromFile(file: File)(implicit codec: Codec): BufferedSource
def fromFile(uri: URI, enc: String): BufferedSource
def fromFile(uri: URI)(implicit codec: Codec): BufferedSource
def fromFile(name: String, enc: String): BufferedSource
def fromFile(name: String)(implicit codec: Codec): BufferedSource
def fromInputStream(is: InputStream)(implicit codec: Codec): BufferedSource
def fromInputStream(is: InputStream, enc: String): BufferedSource
def fromIterable(iterable: Iterable[Char]): Source
Creates a Source from an Iterable.
- iterable
the Iterable
- returns
the Source
def fromRawBytes(bytes: Array[Byte]): Source
def fromResource(resource: String, classLoader: ClassLoader = ...)(implicit codec: Codec): BufferedSource
Reads data from a classpath resource, using either a context classloader (default) or a passed one.
- resource
name of the resource to load from the classpath
- classLoader
classloader to be used, or context classloader if not specified
- returns
the buffered source
def fromString(s: String): Source
def fromURI(uri: URI)(implicit codec: Codec): BufferedSource
def fromURL(url: URL)(implicit codec: Codec): BufferedSource
def fromURL(url: URL, enc: String): BufferedSource
def fromURL(s: String)(implicit codec: Codec): BufferedSource
def fromURL(s: String, enc: String): BufferedSource
final def getClass(): Class[_]
Returns the runtime class representation of the object.
- returns
a class object corresponding to the runtime type of the receiver.
def hashCode(): Int
The hashCode method for reference types. See hashCode in scala.Any.
- returns
the hash code value for this object.
final def isInstanceOf[T0]: Boolean
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 return false
, while the expression List(1).isInstanceOf[List[String]]
will return true
. 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)
.
- 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.
- 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.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
def stdin: BufferedSource
final def synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
def toString(): String
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
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
© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.12.9/scala/io/Source$.html
This object provides convenience methods to create an iterable representation of a source file.