Reader

Type Members

class ReaderDiscarded extends Exception
trait Writable extends Reader with Writer with Closable

A Reader that is linked with a Writer and close-ing is synchronous.
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")
}
```

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
val Null: Reader
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def concat(readers: AsyncStream[Reader]): Reader

Convenient abstraction to read from a stream of Readers as if it were a single Reader.
def copy(r: Reader, w: Writer): Future[Unit]

Copy the bytes from a Reader to a Writer in chunks of size Writer.BufferSize.
Copy the bytes from a Reader to a Writer in chunks of size Writer.BufferSize. The Writer is unmanaged, the caller is responsible for finalization and error handling, e.g.:
```
Reader.copy(r, w) ensure w.close()
```
def copy(r: Reader, w: Writer, n: Int): Future[Unit]

Copy the bytes from a Reader to a Writer in chunks of size n.
Copy the bytes from a Reader to a Writer in chunks of size n. The Writer is unmanaged, the caller is responsible for finalization and error handling, e.g.:
```
Reader.copy(r, w, n) ensure w.close()
```
n
The number of bytes to read on each refill of the Writer.
def copyMany(readers: AsyncStream[Reader], target: Writer): Future[Unit]

Copy bytes from many Readers to a Writer.
Copy bytes from many Readers to a Writer. The Writer is unmanaged, the caller is responsible for finalization and error handling, e.g.:
```
Reader.copyMany(readers, writer) ensure writer.close()
```
def copyMany(readers: AsyncStream[Reader], target: Writer, bufsize: Int): Future[Unit]

Copy bytes from many Readers to a Writer.
Copy bytes from many Readers to a Writer. The Writer is unmanaged, the caller is responsible for finalization and error handling, e.g.:
```
Reader.copyMany(readers, writer) ensure writer.close()
```
bufsize
The number of bytes to read each time.
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] )
def fromBuf(buf: Buf): Reader

Reader from a Buf.
def fromFile(f: File): Reader

Create a new Reader for a File.
Create a new Reader for a File.
The resources held by the returned Reader are released on reading of EOF and Reader.discard().

Annotations
@throws( classOf[FileNotFoundException] ) @throws( classOf[SecurityException] )
See also
Readers.fromFile for a Java API
def fromStream(s: InputStream): Reader

Wrap InputStream with a Reader.
Wrap InputStream with a Reader.
Note that the given InputStream will be closed on reading of EOF and Reader.discard().

See also
Readers.fromStream for a Java API
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
def readAll(r: Reader): Future[Buf]

Read the entire bytestream presented by r.
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( ... )
def writable(): Writable

Create a new Writable which is a Reader that is linked with a Writer.
Create a new Writable which is a Reader that is linked with a Writer.

See also
Readers.writable() for a Java API.

Related Docs: trait Reader | package io

object Reader

Type Members

class ReaderDiscarded extends Exception

trait Writable extends Reader with Writer with Closable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val Null: Reader

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def concat(readers: AsyncStream[Reader]): Reader

def copy(r: Reader, w: Writer): Future[Unit]

def copy(r: Reader, w: Writer, n: Int): Future[Unit]

def copyMany(readers: AsyncStream[Reader], target: Writer): Future[Unit]

def copyMany(readers: AsyncStream[Reader], target: Writer, bufsize: Int): Future[Unit]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def fromBuf(buf: Buf): Reader

def fromFile(f: File): Reader

def fromStream(s: InputStream): Reader

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

def readAll(r: Reader): Future[Buf]

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

def writable(): Writable

Inherited from AnyRef

Inherited from Any

Ungrouped