Packages

object Source

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

Source
Source.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Source
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. 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
  2. final def ##: Int

    Equivalent to x.hashCode except for boxed numeric types and null.

    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
  3. final def ==(arg0: Any): Boolean

    The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    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
  4. val DefaultBufSize: Int
  5. 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 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 type T0.

  6. def clone(): AnyRef

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
    Note

    not specified by SLS as a member of AnyRef

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

  8. 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 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
  9. def equals(arg0: AnyRef): Boolean

    The equality method for reference types.

    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
  10. 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 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

  11. def fromBytes(bytes: Array[Byte], enc: String): Source
  12. 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.

  13. def fromChar(c: Char): Source

    Creates a Source instance from a single character.

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

    creates Source from array of characters, with empty description.

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

  16. def fromFile(file: File, enc: String, bufferSize: Int): BufferedSource
  17. def fromFile(file: File, enc: String): BufferedSource

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

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

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

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

    creates Source from file with given file: URI

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

    creates source from file with given file URI.

  21. def fromFile(name: String, enc: String): BufferedSource

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

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

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

  23. def fromInputStream(is: InputStream)(implicit codec: Codec): BufferedSource
  24. def fromInputStream(is: InputStream, enc: String): BufferedSource
  25. def fromIterable(iterable: Iterable[Char]): Source

    Creates a Source from an Iterable.

    Creates a Source from an Iterable.

    iterable

    the Iterable

    returns

    the Source

  26. def fromResource(resource: String, classLoader: ClassLoader = Thread.currentThread().getContextClassLoader())(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

  27. def fromString(s: String): Source

    creates Source from a String, with no description.

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

    creates Source from file with given file: URI

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

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

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

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

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

    same as fromURL(new URL(s))

  32. def fromURL(s: String, enc: String): BufferedSource

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

  33. final def getClass(): Class[_ <: AnyRef]

    Returns the runtime class representation of the object.

    Returns the runtime class representation of the object.

    returns

    a class object corresponding to the runtime type of the receiver.

    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  34. def hashCode(): Int

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in scala.Any.

    returns

    the hash code value for this object.

    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  35. final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object has the same erasure as T0.

    Test whether the dynamic type of the receiver object has the same erasure as T0.

    Depending on what T0 is, the test is done in one of the below ways:

    • T0 is a non-parameterized class type, e.g. BigDecimal: this method returns true if the value of the receiver object is a BigDecimal or a subtype of BigDecimal.
    • T0 is a parameterized class type, e.g. List[Int]: this method returns true if the value of the receiver object is some List[X] for any X. For example, List(1, 2, 3).isInstanceOf[List[String]] will return true.
    • T0 is some singleton type x.type or literal x: this method returns this.eq(x). For example, x.isInstanceOf[1] is equivalent to x.eq(1)
    • T0 is an intersection X with Y or X & Y: this method is equivalent to x.isInstanceOf[X] && x.isInstanceOf[Y]
    • T0 is a union X | Y: this method is equivalent to x.isInstanceOf[X] || x.isInstanceOf[Y]
    • T0 is a type parameter or an abstract type member: this method is equivalent to isInstanceOf[U] where U is T0's upper bound, Any if T0 is unbounded. For example, x.isInstanceOf[A] where A is an unbounded type parameter will return true for any value of x.

    This is exactly equivalent to the type pattern _: T0

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    Definition Classes
    Any
    Note

    due to the unexpectedness of List(1, 2, 3).isInstanceOf[List[String]] returning true and x.isInstanceOf[A] where A is a type parameter or abstract member returning true, these forms issue a warning.

  36. 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
  37. 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

  38. 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

  39. def stdin: BufferedSource

    Creates a Source from System.in.

  40. final def synchronized[T0](arg0: => T0): T0

    Executes the code in body with an exclusive lock on this.

    Executes the code in body with an exclusive lock on this.

    returns

    the result of body

    Definition Classes
    AnyRef
  41. 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
  42. final def wait(): Unit

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--.

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--.

    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
    Note

    not specified by SLS as a member of AnyRef

  43. final def wait(arg0: Long, arg1: Int): Unit

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-

    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
    Note

    not specified by SLS as a member of AnyRef

  44. final def wait(arg0: Long): Unit

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-.

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-.

    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
    Note

    not specified by SLS as a member of AnyRef

Deprecated Value Members

  1. 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.)

    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.9) Use fromBytes and specify an encoding

Inherited from AnyRef

Inherited from Any

Ungrouped