implicit final class ReadableExtensions[R <: IReadable] extends AnyVal
- Alphabetic
- By Inheritance
- ReadableExtensions
- AnyVal
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ReadableExtensions(readable: R)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- Any
- final def ##: Int
- Definition Classes
- Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def getClass(): Class[_ <: AnyVal]
- Definition Classes
- AnyVal → Any
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def iteratorAsBuffer: Iterator[Buffer]
- Annotations
- @inline()
- def iteratorAsObject: Iterator[Any]
- Annotations
- @inline()
- def iteratorAsString: Iterator[String]
- Annotations
- @inline()
- def onClose(listener: () => Any): R
Emitted when the stream and any of its underlying resources (a file descriptor, for example) have been closed.
Emitted when the stream and any of its underlying resources (a file descriptor, for example) have been closed. The event indicates that no more events will be emitted, and no further computation will occur.
- Annotations
- @inline()
- def onData[A](listener: (A) => Any): R
Attaching a 'data' event listener to a stream that has not been explicitly paused will switch the stream into flowing mode.
Attaching a 'data' event listener to a stream that has not been explicitly paused will switch the stream into flowing mode. Data will then be passed as soon as it is available.
- Annotations
- @inline()
- def onEnd(listener: () => Any): R
This event fires when there will be no more data to read.
This event fires when there will be no more data to read. Note that the 'end' event will not fire unless the data is completely consumed. This can be done by switching into flowing mode, or by calling stream.read() repeatedly until you get to the end.
- Annotations
- @inline()
- def onError(listener: (Error) => Any): R
Emitted if there was an error when writing or piping data.
Emitted if there was an error when writing or piping data.
- Annotations
- @inline()
- def onPause(listener: () => Any): R
- Annotations
- @inline()
- def onReadable(listener: () => Any): R
When a chunk of data can be read from the stream, it will emit a 'readable' event.
When a chunk of data can be read from the stream, it will emit a 'readable' event. In some cases, listening for a 'readable' event will cause some data to be read into the internal buffer from the underlying system, if it hadn't already.
- Annotations
- @inline()
- def onResume(listener: () => Any): R
- Annotations
- @inline()
- def readAsBufferOption(): Option[Buffer]
- Annotations
- @inline()
- def readAsObjectOption(): Option[Any]
- Annotations
- @inline()
- def readAsStringOption(): Option[String]
- Annotations
- @inline()
- def toString(): String
- Definition Classes
- Any