abstract class AbstractReader[+A] extends Reader[A]
Abstract Reader class for Java compatibility.
- Alphabetic
- By Inheritance
- AbstractReader
- Reader
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new AbstractReader()
Abstract Value Members
- abstract def discard(): Unit
Discard this stream as its output is no longer required.
Discard this stream as its output is no longer required. This could be used to signal the producer of this stream similarly how com.twitter.util.Future.raise used to propagate interrupts across future chains.
- Definition Classes
- Reader
- Note
Although unnecessary, it's always safe to discard a fully-consumed stream.
- abstract def onClose: Future[StreamTermination]
A com.twitter.util.Future that resolves once this reader is closed upon reading of end-of-stream.
A com.twitter.util.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
- Reader
- abstract def read(): Future[Option[A]]
Asynchronously read the next element of this stream.
Asynchronously read the next element of this stream. Returned com.twitter.util.Future will resolve into
Some(e)when the element is available or intoNonewhen stream is exhausted.Stream failures are terminal such that all subsequent reads will resolve in failed com.twitter.util.Futures.
- Definition Classes
- Reader
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def flatMap[B](f: (A) => Reader[B]): Reader[B]
Construct a new Reader by applying
fto every item read from this ReaderConstruct a new Reader by applying
fto every item read from this Reader- f
the function constructs a new Reader[B] from the value of this Reader.read
- Definition Classes
- Reader
- Note
All operations of the new Reader will be in sync with self Reader. Discarding one Reader will discard the other Reader. When one Reader's onClose resolves, the other Reader's onClose will be resolved immediately with the same value.
- def flatten[B](implicit ev: <:<[A, Reader[B]]): Reader[B]
Converts a
Reader[Reader[B]]into aReader[B]Converts a
Reader[Reader[B]]into aReader[B]- Definition Classes
- Reader
- Note
All operations of the new Reader will be in sync with the outermost Reader. Discarding one Reader will discard the other Reader. When one Reader's onClose resolves, the other Reader's onClose will be resolved immediately with the same value. The subsequent readers are unmanaged, the caller is responsible for discarding those when abandoned.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def map[B](f: (A) => B): Reader[B]
Construct a new Reader by applying
fto every item read from this ReaderConstruct a new Reader by applying
fto every item read from this Reader- f
the function transforms data of type A to B
- Definition Classes
- Reader
- Note
All operations of the new Reader will be in sync with self Reader. Discarding one Reader will discard the other Reader. When one Reader's onClose resolves, the other Reader's onClose will be resolved immediately with the same value.
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()