scala.io

Source

object Source extends AnyRef

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

Inherits

  1. AnyRef
  2. Any

Value Members

  1. val DefaultBufSize: Int

  2. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an equivalence relation:

    • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
    • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
    • It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef ⇐ Any
  3. def fromBytes(bytes: Array[Byte])(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.

    bytes

    ...

    returns

    the created Source instance.

  4. def fromChar(c: Char): Source

    Creates a Source instance from a single character

    Creates a Source instance from a single character.

    c

    ...

    returns

    the create Source instance.

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

    creates Source from array of characters, with empty description

    creates Source from array of characters, with empty description.

    chars

    ...

    returns

    ...

  6. def fromFile(file: File, bufferSize: Int)(codec: Codec): Source

    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 size bufferSize.

  7. def fromInputStream(inputStream: InputStream, bufferSize: Int, reset: () ⇒ Source, close: () ⇒ Unit)(codec: Codec): Source

    Reads data from inputStream with a buffered reader, using encoding in implicit parameter codec

    Reads data from inputStream with a buffered reader, using 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)

    codec

    (implicit) a scala.io.Codec specifying behavior (defaults to Codec.default)

    returns

    the buffered source

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

    Creates a Source from an Iterable

    Creates a Source from an Iterable.

    iterable

    the Iterable

    returns

    the Source instance.

  9. def fromPath(name: String)(codec: Codec): Source

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

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

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

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

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

  11. def fromString(s: String): Source

    creates Source from string, with empty description

    creates Source from string, with empty description.

    s

    ...

    returns

    ...

  12. def fromURI(uri: URI)(codec: Codec): Source

    creates Source from file with given file: URI

    creates Source from file with given file: URI

  13. def fromURL(url: URL)(codec: Codec): Source

    same as fromInputStream(url

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

  14. def hashCode(): Int

    Returns a hash code value for the object

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    definition classes: AnyRef ⇐ Any
  15. def stdin: Source

    Creates a Source from System

    Creates a Source from System.in.

  16. def toString(): String

    Returns a string representation of the object

    Returns a string representation of the object.

    The default representation is platform dependent.

    definition classes: AnyRef ⇐ Any