vertx-lang-scala-docs_2.12 3.8.0 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package core
  Definition Classes
    scala
-  package streams
  Definition Classes
    core
- Pipe
- Pump
- ReadStream
- StreamBase
- WriteStream

t

io.vertx.scala.core.streams

# ReadStream 

###
Companion object ReadStream

#### trait ReadStream[T] extends StreamBase

Represents a stream of items that can be read from.

Any class that implements this interface can be used by a io.vertx.scala.core.streams.Pump to pump data from it to a io.vertx.scala.core.streams.WriteStream.

##### Streaming mode

The stream is either in flowing or fetch mode.

Initially the stream is in flowing mode.

- When the stream is in flowing mode, elements are delivered to the `handler`.
- When the stream is in fetch mode, only the number of requested elements will be delivered to the `handler`.

The mode can be changed with the io.vertx.scala.core.streams.ReadStream#pause, io.vertx.scala.core.streams.ReadStream#resume and io.vertx.scala.core.streams.ReadStream#fetch methods:

- Calling io.vertx.scala.core.streams.ReadStream#resume sets the flowing mode
- Calling io.vertx.scala.core.streams.ReadStream#pause sets the fetch mode and resets the demand to `0`
- Calling io.vertx.scala.core.streams.ReadStream#fetch requests a specific amount of elements and adds it to the actual demand

Linear Supertypes
StreamBase, AnyRef, Any
Known Subclasses
TimeoutStream, DatagramSocket, MessageConsumer, AsyncFile, HttpClientRequest, HttpClientResponse, HttpServerFileUpload, HttpServerRequest, ServerWebSocket, WebSocket, WebSocketBase, NetSocket, JsonParser, RecordParser, SQLRowStream, SockJSSocket, KafkaConsumer, RabbitMQConsumer, Redis
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. ReadStream
2. StreamBase
3. AnyRef
4. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Abstract Value Members

1.  abstract def asJava: AnyRef
   Definition Classes
     ReadStream → StreamBase
2.  abstract def endHandler(endHandler: Handler[Unit]): ReadStream[T]

   Set an end handler.

   Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called. * @return a reference to this, so the API can be used fluently

3.  abstract def exceptionHandler(handler: Handler[Throwable]): ReadStream[T]

   Set an exception handler on the read stream.

   Set an exception handler on the read stream. * @param handler the exception handler

   returns

     a reference to this, so the API can be used fluently

   Definition Classes
     ReadStream → StreamBase
4.  abstract def fetch(amount: Long): ReadStream[T]

   Fetch the specified `amount` of elements.

   Fetch the specified `amount` of elements. If the `ReadStream` has been paused, reading will recommence with the specified `amount` of items, otherwise the specified `amount` will be added to the current stream demand. * @return a reference to this, so the API can be used fluently

5.  abstract def handler(handler: Handler[T]): ReadStream[T]

   Set a data handler.

   Set a data handler. As data is read, the handler will be called with the data. * @return a reference to this, so the API can be used fluently

6.  abstract def pause(): ReadStream[T]

   Pause the `ReadStream`, it sets the buffer in `fetch` mode and clears the actual demand.

   Pause the `ReadStream`, it sets the buffer in `fetch` mode and clears the actual demand.

   While it's paused, no data will be sent to the data `handler`. * @return a reference to this, so the API can be used fluently

7.  abstract def pipe(): Pipe[T]

   Pause this stream and return a io.vertx.scala.core.streams.Pipe to transfer the elements of this stream to a destination io.vertx.scala.core.streams.WriteStream.

   Pause this stream and return a io.vertx.scala.core.streams.Pipe to transfer the elements of this stream to a destination io.vertx.scala.core.streams.WriteStream.

   The stream will be resumed when the pipe will be wired to a `WriteStream`. * @return a pipe

8.  abstract def pipeTo(dst: WriteStream[T], handler: Handler[AsyncResult[Unit]]): Unit

   Pipe this `ReadStream` to the `WriteStream`.

   Pipe this `ReadStream` to the `WriteStream`.

   Elements emitted by this stream will be written to the write stream until this stream ends or fails.

   Once this stream has ended or failed, the write stream will be ended and the `handler` will be called with the result. * @param dst the destination write stream

9.  abstract def pipeTo(dst: WriteStream[T]): Unit

   Like io.vertx.scala.core.streams.ReadStream#pipeTo but with no completion handler.

10.  abstract def pipeToFuture(dst: WriteStream[T]): scala.concurrent.Future[Unit]

    Like pipeTo but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

11.  abstract def resume(): ReadStream[T]

    Resume reading, and sets the buffer in `flowing` mode.

    Resume reading, and sets the buffer in `flowing` mode.

    If the `ReadStream` has been paused, reading will recommence on it. * @return a reference to this, so the API can be used fluently

### Concrete 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.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
7.  def equals(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
8.  def finalize(): Unit
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( classOf[java.lang.Throwable] )
9.  final def getClass(): Class[_]
   Definition Classes
     AnyRef → Any
   Annotations
     @native()
10.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
11.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
12.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
14.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
15.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
16.  def toString(): String
    Definition Classes
      AnyRef → Any
17.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
18.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
19.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )

### Inherited from StreamBase

### Inherited from AnyRef

### Inherited from Any

### Ungrouped