Scala 3
3.10.0-RC1-bin-20260725-a036a3a-NIGHTLY
LearnInstallPlaygroundFind A LibraryCommunityBlog
LearnInstallPlaygroundFind A LibraryCommunityBlog
DocsAPI
Generated with
Copyright (c) 2002-2026, LAMP/EPFL
Copyright (c) 2002-2026, LAMP/EPFL
Scala 3/scala/scala.io/Source

Source

scala.io.Source
See theSource companion class
object Source

This object provides convenience methods to create an iterable representation of a source file.

Attributes

Companion
class
Source
Source.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Source.type

Members list

Value members

Concrete methods

def createBufferedSource(inputStream: InputStream, bufferSize: Int = ..., 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.

Value parameters

bufferSize

buffer size (defaults to Source.DefaultBufSize)

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)

inputStream

the input stream from which to read

reset

a () => Source which resets the stream (if unset, reset() will throw an Exception)

Attributes

Returns

a BufferedSource reading from inputStream with the given buffer size

Source
Source.scala
def fromBytes(bytes: Array[Byte])(implicit codec: Codec): Source

Creates a Source from array of bytes, decoding the bytes according to codec.

Creates a Source from array of bytes, decoding the bytes according to codec.

Value parameters

bytes

the array of bytes to decode into characters

codec

the implicit codec used for character encoding

Attributes

Returns

a Source that yields the characters decoded from bytes using codec

Source
Source.scala
def fromBytes(bytes: Array[Byte], enc: String): Source

Attributes

Source
Source.scala
def fromChar(c: Char): Source

Creates a Source instance from a single character.

Creates a Source instance from a single character.

Value parameters

c

the character to use as the source content

Attributes

Returns

a Source that yields the single character c

Source
Source.scala
def fromChars(chars: Array[Char]): Source

Creates Source from array of characters, with empty description.

Creates Source from array of characters, with empty description.

Value parameters

chars

the array of characters to use as the source content

Attributes

Returns

a Source that yields the characters from chars

Source
Source.scala
def fromFile(name: String)(implicit codec: Codec): BufferedSource

Creates Source from file with given name, setting its description to filename.

Creates Source from file with given name, setting its description to filename.

Value parameters

codec

the implicit codec used for character encoding

name

the name of the file to read

Attributes

Returns

a BufferedSource reading from the named file, described by its filename

Source
Source.scala
def fromFile(name: String, enc: String): BufferedSource

Creates Source from file with given name, using given encoding, setting its description to filename.

Creates Source from file with given name, using given encoding, setting its description to filename.

Value parameters

enc

the name of the character encoding to use

name

the name of the file to read

Attributes

Returns

a BufferedSource reading from the named file with the given encoding

Source
Source.scala
def fromFile(uri: URI)(implicit codec: Codec): BufferedSource

Creates source from file with given file URI.

Creates source from file with given file URI.

Value parameters

codec

the implicit codec used for character encoding

uri

the file URI to read from

Attributes

Returns

a BufferedSource reading from the file referenced by uri

Source
Source.scala
def fromFile(uri: URI, enc: String): BufferedSource

Creates Source from file with given file: URI

Creates Source from file with given file: URI

Value parameters

enc

the name of the character encoding to use

uri

the file URI to read from

Attributes

Returns

a BufferedSource reading from the file referenced by uri with the given encoding

Source
Source.scala
def fromFile(file: File)(implicit codec: Codec): BufferedSource

Creates Source from file, using default character encoding, setting its description to filename.

Creates Source from file, using default character encoding, setting its description to filename.

Value parameters

codec

the implicit codec used for character encoding

file

the file to read from

Attributes

Returns

a BufferedSource reading from file with the default buffer size

Source
Source.scala
def fromFile(file: File, enc: String): BufferedSource

same as fromFile(file, enc, Source.DefaultBufSize)

same as fromFile(file, enc, Source.DefaultBufSize)

Value parameters

enc

the name of the character encoding to use

file

the file to read from

Attributes

Returns

a BufferedSource reading from file with the given encoding

Source
Source.scala
def fromFile(file: File, enc: String, bufferSize: Int): BufferedSource

Attributes

Source
Source.scala
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.

Creates Source from file, using given character encoding, setting its description to filename. Input is buffered in a buffer of size bufferSize.

Value parameters

bufferSize

the size of the input buffer, in characters

codec

the implicit codec used for character encoding

file

the file to read from

Attributes

Returns

a BufferedSource reading from file with the given buffer size, described by the file's absolute path

Source
Source.scala
def fromInputStream(is: InputStream, enc: String): BufferedSource

Attributes

Source
Source.scala
def fromInputStream(is: InputStream)(implicit codec: Codec): BufferedSource

Attributes

Source
Source.scala
def fromIterable(iterable: Iterable[Char]): Source

Creates a Source from an Iterable.

Creates a Source from an Iterable.

Value parameters

iterable

the Iterable

Attributes

Returns

the Source

Source
Source.scala
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.

Value parameters

classLoader

classloader to be used, or context classloader if not specified

codec

the implicit codec used for character encoding

resource

name of the resource to load from the classpath

Attributes

Returns

the buffered source

Source
Source.scala
def fromString(s: String): Source

Creates Source from a String, with no description.

Creates Source from a String, with no description.

Value parameters

s

the string to use as the source content

Attributes

Returns

a Source that yields the characters of s

Source
Source.scala
def fromURI(uri: URI)(implicit codec: Codec): BufferedSource

creates Source from file with given file: URI

creates Source from file with given file: URI

Value parameters

codec

the implicit codec used for character encoding

uri

the file URI to read from

Attributes

Returns

a BufferedSource reading from the file referenced by uri

Source
Source.scala
def fromURL(s: String, enc: String): BufferedSource

Same as fromURL(new URL(s))(Codec(enc))

Same as fromURL(new URL(s))(Codec(enc))

Value parameters

enc

the name of the character encoding to use

s

the URL string to read from

Attributes

Returns

a BufferedSource reading from the URL given by s with the given encoding

Source
Source.scala
def fromURL(s: String)(implicit codec: Codec): BufferedSource

Same as fromURL(new URL(s))

Same as fromURL(new URL(s))

Value parameters

codec

the implicit codec used for character encoding

s

the URL string to read from

Attributes

Returns

a BufferedSource reading from the URL given by s

Source
Source.scala
def fromURL(url: URL, enc: String): BufferedSource

Same as fromInputStream(url.openStream())(Codec(enc))

Same as fromInputStream(url.openStream())(Codec(enc))

Value parameters

enc

the name of the character encoding to use

url

the URL to read from

Attributes

Returns

a BufferedSource reading from the stream opened on url with the given encoding

Source
Source.scala
def fromURL(url: URL)(implicit codec: Codec): BufferedSource

Same as fromInputStream(url.openStream())(codec)

Same as fromInputStream(url.openStream())(codec)

Value parameters

codec

the implicit codec used for character encoding

url

the URL to read from

Attributes

Returns

a BufferedSource reading from the stream opened on url

Source
Source.scala
def stdin: BufferedSource

Creates a Source from System.in.

Creates a Source from System.in.

Attributes

Source
Source.scala

Deprecated methods

def fromRawBytes(bytes: Array[Byte]): Source

Creates a Source from array of bytes, assuming one byte per character (ISO-8859-1 encoding.)

Creates a Source from array of bytes, assuming one byte per character (ISO-8859-1 encoding.)

Attributes

Deprecated
[Since version 2.13.9] Use `fromBytes` and specify an encoding
Source
Source.scala

Concrete fields

val DefaultBufSize: Int

Attributes

Source
Source.scala
Generated with
Copyright (c) 2002-2026, LAMP/EPFL
Copyright (c) 2002-2026, LAMP/EPFL