object Source
This object provides convenience methods to create an iterable representation of a source file.
- Source
- Source.scala
- Alphabetic
- By Inheritance
- Source
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
- val DefaultBufSize: Int
-
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.
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
- 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.Create a
Source
from array of bytes, decoding the bytes according to codec.- returns
the created
Source
instance.
-
def
fromChar(c: Char): Source
Creates a Source instance from a single character.
-
def
fromChars(chars: Array[Char]): Source
creates Source from array of characters, with empty description.
-
def
fromFile(file: File, bufferSize: Int)(implicit codec: Codec): BufferedSource
Creates Source from
file
, using given character encoding, setting its description to filename.Creates Source from
file
, using given character encoding, setting its description to filename. Input is buffered in a buffer of sizebufferSize
. - def fromFile(file: File, enc: String, bufferSize: Int): BufferedSource
-
def
fromFile(file: File, enc: String): BufferedSource
same as fromFile(file, enc, Source.DefaultBufSize)
-
def
fromFile(file: File)(implicit codec: Codec): BufferedSource
creates Source from file, using default character encoding, setting its description to filename.
-
def
fromFile(uri: URI, enc: String): BufferedSource
creates Source from file with given file: URI
-
def
fromFile(uri: URI)(implicit codec: Codec): BufferedSource
creates
source
from file with given fileURI
. -
def
fromFile(name: String, enc: String): BufferedSource
creates Source from file with given name, using given encoding, setting its description to filename.
-
def
fromFile(name: String)(implicit codec: Codec): BufferedSource
creates Source from file with given name, setting its description to filename.
- 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.
Creates a Source from an Iterable.
- iterable
the Iterable
- returns
the Source
-
def
fromRawBytes(bytes: Array[Byte]): Source
Create a
Source
from array of bytes, assuming one byte per character (ISO-8859-1 encoding.) -
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.
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
creates Source from a String, with no description.
-
def
fromURI(uri: URI)(implicit codec: Codec): BufferedSource
creates
Source
from file with given file: URI -
def
fromURL(url: URL)(implicit codec: Codec): BufferedSource
same as fromInputStream(url.openStream())(codec)
-
def
fromURL(url: URL, enc: String): BufferedSource
same as fromInputStream(url.openStream())(Codec(enc))
-
def
fromURL(s: String)(implicit codec: Codec): BufferedSource
same as fromURL(new URL(s))
-
def
fromURL(s: String, enc: String): BufferedSource
same as fromURL(new URL(s))(Codec(enc))
-
def
stdin: BufferedSource
Creates a
Source
from System.in.
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
.