Writable

A Reader that is linked with a Writer and close-ing is synchronous.

Just as with readers and writers, only one outstanding read or write is permitted.

For a proper close, it should only be done when no writes are outstanding:

val rw = Reader.writable()
...
rw.write(buf).before(rw.close())

If a producer is interested in knowing when all writes have been read and the reader has seen the EOF, it can wait until the future returned by close() is satisfied:

val rw = Reader.writable()
...
rw.close().ensure {
  println("party on! ♪┏(・o･)┛♪ the Reader has seen the EOF")
}

Linear Supertypes

Closable, Writer, Reader, AnyRef, Any

Abstract Value Members

abstract def close(deadline: Time): Future[Unit]

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

Definition Classes
Closable
abstract def discard(): Unit

Discard this reader: its output is no longer required.
Discard this reader: its output is no longer required.

Definition Classes
Reader
abstract def fail(cause: Throwable): Unit

Indicate that the producer of the bytestream has failed.
Indicate that the producer of the bytestream has failed. No further writes are allowed.

Definition Classes
Writer
abstract def read(n: Int): Future[Option[Buf]]

Asynchronously read at most n bytes from the byte stream.
Asynchronously read at most n bytes from the byte stream. The returned future represents the results of the read request. If the read fails, the Reader is considered failed -- future reads will also fail.
A result of None indicates EOF.

Definition Classes
Reader
abstract def write(buf: Buf): Future[Unit]

Write a chunk.
Write a chunk. The returned future is completed when the chunk has been fully read by the sink.
Only one outstanding write is permitted, thus backpressure is asserted.

Definition Classes
Writer

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[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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
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
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package Reader

trait Writable extends Reader with Writer with Closable

Abstract Value Members

abstract def close(deadline: Time): Future[Unit]

abstract def discard(): Unit

abstract def fail(cause: Throwable): Unit

abstract def read(n: Int): Future[Option[Buf]]

abstract def write(buf: Buf): Future[Unit]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def close(after: Duration): Future[Unit]

final def close(): Future[Unit]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Closable

Inherited from Writer

Inherited from Reader

Inherited from AnyRef

Inherited from Any

Ungrouped