class InputStreamReader extends Reader[Buf] with Closable with CloseAwaitably

Provides the Reader API for an InputStream.

The given InputStream will be closed when Reader.read reaches the EOF or a call to discard() or close().

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InputStreamReader
  2. CloseAwaitably
  3. CloseAwaitably0
  4. Awaitable
  5. Closable
  6. Reader
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new InputStreamReader(inputStream: InputStream, chunkSize: Int)

    Constructs an InputStreamReader out of a given inputStream.

    Constructs an InputStreamReader out of a given inputStream. The resulting Reader emits chunks of at most chunkSize.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. def close(deadline: Time): Future[Unit]

    Discards this Reader and closes the underlying InputStream

    Discards this Reader and closes the underlying InputStream

    Definition Classes
    InputStreamReaderClosable
  7. def close(after: Duration): Future[Unit]

    Close the resource with the given timeout.

    Close the resource with the given timeout. This timeout is advisory, giving the callee some leeway, for example to drain clients or finish up other tasks.

    Definition Classes
    Closable
  8. final def close(): Future[Unit]

    Close the resource.

    Close the resource. The returned Future is completed when the resource has been fully relinquished.

    Definition Classes
    Closable
  9. def closeAwaitably(f: ⇒ Future[Unit]): Future[Unit]

    closeAwaitably is intended to be used as a wrapper for close.

    closeAwaitably is intended to be used as a wrapper for close. The underlying f will be called at most once.

    Attributes
    protected
    Definition Classes
    CloseAwaitably0
  10. def discard(): Unit

    Discard this reader: its output is no longer required.

    Discard this reader: its output is no longer required.

    This asynchronously closes the underlying InputStream.

    Definition Classes
    InputStreamReaderReader
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def flatMap[B](f: (Buf) ⇒ Reader[B]): Reader[B]

    Construct a new Reader by applying f to every item read from this Reader

    Construct a new Reader by applying f to every item read from this Reader

    f

    the function constructs a new Reader[B] from the value of this Reader.read

    Definition Classes
    Reader
  15. def flatten[B](implicit ev: <:<[Buf, Reader[B]]): Reader[B]

    Converts a Reader[Reader[B]] into a Reader[B]

    Converts a Reader[Reader[B]] into a Reader[B]

    Definition Classes
    Reader
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def isReady(implicit permit: CanAwait): Boolean

    Is this Awaitable ready? In other words: would calling Awaitable.ready block?

    Is this Awaitable ready? In other words: would calling Awaitable.ready block?

    Definition Classes
    CloseAwaitably0 → Awaitable
  20. final def map[B](f: (Buf) ⇒ B): Reader[B]

    Construct a new Reader by applying f to every item read from this Reader

    Construct a new Reader by applying f to every item read from this Reader

    f

    the function transforms data of type A to B

    Definition Classes
    Reader
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. def onClose: Future[StreamTermination]

    A Future that resolves once this reader is closed upon reading of end-of-stream.

    A Future that resolves once this reader is closed upon reading of end-of-stream.

    If the result is a failed future, this indicates that it was not closed either by reading until the end of the stream nor by discarding. This is useful for any extra resource cleanup that you must do once the stream is no longer being used.

    Definition Classes
    InputStreamReaderReader
  25. def read(): Future[Option[Buf]]

    Asynchronously read at most min(n, maxBufferSize) bytes from the InputStream.

    Asynchronously read at most min(n, maxBufferSize) bytes from the InputStream. The returned Future represents the results of the read operation. Any failure indicates an error; an empty buffer indicates that the stream has completed.

    Definition Classes
    InputStreamReaderReader
    Note

    the underlying InputStream is closed on read of EOF.

  26. def ready(timeout: Duration)(implicit permit: CanAwait): InputStreamReader.this.type

    Support for Await.ready.

    Support for Await.ready. The use of the implicit permit is an access control mechanism: only Await.ready may call this method.

    Definition Classes
    CloseAwaitably0 → Awaitable
  27. def result(timeout: Duration)(implicit permit: CanAwait): Unit

    Support for Await.result.

    Support for Await.result. The use of the implicit permit is an access control mechanism: only Await.result may call this method.

    Definition Classes
    CloseAwaitably0 → Awaitable
  28. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from CloseAwaitably

Inherited from CloseAwaitably0[Unit]

Inherited from Awaitable[Unit]

Inherited from Closable

Inherited from Reader[Buf]

Inherited from AnyRef

Inherited from Any

Ungrouped