fs2.io

package fs2.io

Provides various ways to work with streams that perform IO.

Type members

Classlikes

class ClosedChannelException extends IOException
trait Duplex extends Readable with Writable

A facade for Node.js stream.Duplex. Extend or cast to/from your own bindings.

A facade for Node.js stream.Duplex. Extend or cast to/from your own bindings.

See also:
Source:
NodeStream.scala
class InterruptedIOException(message: String, cause: Throwable) extends IOException
Companion:
object
Source:
IOException.scala
trait Readable

A facade for Node.js stream.Readable. Extend or cast to/from your own bindings.

A facade for Node.js stream.Readable. Extend or cast to/from your own bindings.

See also:
Source:
NodeStream.scala
final class StreamDestroyedException extends IOException
trait Writable

A facade for Node.js stream.Writable. Extend or cast to/from your own bindings.

A facade for Node.js stream.Writable. Extend or cast to/from your own bindings.

See also:
Source:
NodeStream.scala

Types

type IOException = IOException
Source:
io.scala

Value members

Concrete methods

def readInputStream[F[_]](fis: F[InputStream], chunkSize: Int, closeAfterUse: Boolean)(implicit F: Sync[F]): Stream[F, Byte]

Reads all bytes from the specified InputStream with a buffer size of chunkSize. Set closeAfterUse to false if the InputStream should not be closed after use.

Reads all bytes from the specified InputStream with a buffer size of chunkSize. Set closeAfterUse to false if the InputStream should not be closed after use.

Source:
io.scala
def unsafeReadInputStream[F[_]](fis: F[InputStream], chunkSize: Int, closeAfterUse: Boolean)(implicit F: Sync[F]): Stream[F, Byte]

Reads all bytes from the specified InputStream with a buffer size of chunkSize. Set closeAfterUse to false if the InputStream should not be closed after use.

Reads all bytes from the specified InputStream with a buffer size of chunkSize. Set closeAfterUse to false if the InputStream should not be closed after use.

Recycles an underlying input buffer for performance. It is safe to call this as long as whatever consumes this Stream does not store the Chunk returned or pipe it to a combinator that does (e.g. buffer). Use readInputStream for a safe version.

Source:
io.scala
def writeOutputStream[F[_]](fos: F[OutputStream], closeAfterUse: Boolean)(implicit F: Sync[F]): (F, Byte) => Nothing

Writes all bytes to the specified OutputStream. Set closeAfterUse to false if the OutputStream should not be closed after use.

Writes all bytes to the specified OutputStream. Set closeAfterUse to false if the OutputStream should not be closed after use.

Each write operation is performed on the supplied execution context. Writes are blocking so the execution context should be configured appropriately.

Source:
io.scala

Inherited methods

def readWritable[F[_] : Async](f: Writable => F[Unit]): Stream[F, Byte]

Take a function that emits to a Writable effectfully, and return a stream which, when run, will perform that function and emit the bytes recorded in the Writable as an fs2.Stream

Take a function that emits to a Writable effectfully, and return a stream which, when run, will perform that function and emit the bytes recorded in the Writable as an fs2.Stream

Inherited from:
ioplatform (hidden)
Source:
ioplatform.scala
def stderr[F[_] : Async]: (F, Byte) => Nothing

Pipe of bytes that writes emitted values to standard error asynchronously.

Pipe of bytes that writes emitted values to standard error asynchronously.

Inherited from:
ioplatform (hidden)
Source:
ioplatform.scala
@nowarn("msg=never used")
def stdin[F[_] : Async](ignored: Int): Stream[F, Byte]

Stream of bytes read asynchronously from standard input. Takes a dummy Int parameter for source-compatibility with JVM.

Stream of bytes read asynchronously from standard input. Takes a dummy Int parameter for source-compatibility with JVM.

Inherited from:
ioplatform (hidden)
Source:
ioplatform.scala
def stdin[F[_] : Async]: Stream[F, Byte]

Stream of bytes read asynchronously from standard input.

Stream of bytes read asynchronously from standard input.

Inherited from:
ioplatform (hidden)
Source:
ioplatform.scala
@nowarn("msg=never used")
def stdinUtf8[F[_] : Async](ignored: Int): Stream[F, String]

Stream of String read asynchronously from standard input decoded in UTF-8. Takes a dummy Int parameter for source-compatibility with JVM.

Stream of String read asynchronously from standard input decoded in UTF-8. Takes a dummy Int parameter for source-compatibility with JVM.

Inherited from:
ioplatform (hidden)
Source:
ioplatform.scala
def stdinUtf8[F[_] : Async]: Stream[F, String]

Stream of String read asynchronously from standard input decoded in UTF-8.

Stream of String read asynchronously from standard input decoded in UTF-8.

Inherited from:
ioplatform (hidden)
Source:
ioplatform.scala
def stdout[F[_] : Async]: (F, Byte) => Nothing

Pipe of bytes that writes emitted values to standard output asynchronously.

Pipe of bytes that writes emitted values to standard output asynchronously.

Inherited from:
ioplatform (hidden)
Source:
ioplatform.scala
def stdoutLines[F[_] : Async, O : Show](charset: Charset): (F, O) => Nothing

Writes this stream to standard output asynchronously, converting each element to a sequence of bytes via Show and the given Charset.

Writes this stream to standard output asynchronously, converting each element to a sequence of bytes via Show and the given Charset.

Inherited from:
ioplatform (hidden)
Source:
ioplatform.scala
def suspendReadableAndRead[F[_], R <: Readable](destroyIfNotEnded: Boolean, destroyIfCanceled: Boolean)(thunk: => R)(implicit F: Async[F]): Resource[F, (R, Stream[F, Byte])]

Suspends the creation of a Readable and a Stream that reads all bytes from that Readable.

Suspends the creation of a Readable and a Stream that reads all bytes from that Readable.

Inherited from:
ioplatform (hidden)
Source:
ioplatform.scala
def toDuplexAndRead[F[_] : Async](f: Duplex => F[Unit]): (F, Byte) => Byte

Take a function that reads and writes from a Duplex effectfully, and return a pipe which, when run, will perform that function, write emitted bytes to the duplex, and read emitted bytes from the duplex

Take a function that reads and writes from a Duplex effectfully, and return a pipe which, when run, will perform that function, write emitted bytes to the duplex, and read emitted bytes from the duplex

Inherited from:
ioplatform (hidden)
Source:
ioplatform.scala
def toReadable[F[_]](implicit F: Async[F]): (F, Byte) => Readable

Pipe that converts a stream of bytes to a stream that will emit a single Readable, that ends whenever the resulting stream terminates.

Pipe that converts a stream of bytes to a stream that will emit a single Readable, that ends whenever the resulting stream terminates.

Inherited from:
ioplatform (hidden)
Source:
ioplatform.scala

Like toReadable but returns a Resource rather than a single element stream.

Like toReadable but returns a Resource rather than a single element stream.

Inherited from:
ioplatform (hidden)
Source:
ioplatform.scala
def writeWritable[F[_]](writable: F[Writable], endAfterUse: Boolean)(implicit F: Async[F]): (F, Byte) => Nothing

Writes all bytes to the specified Writable.

Writes all bytes to the specified Writable.

Inherited from:
ioplatform (hidden)
Source:
ioplatform.scala

Deprecated and Inherited methods

@deprecated("Use suspendReadableAndRead instead", "3.1.4")
def readReadable[F[_]](readable: F[Readable], destroyIfNotEnded: Boolean, destroyIfCanceled: Boolean)(implicit F: Async[F]): Stream[F, Byte]
Deprecated
Inherited from:
ioplatform (hidden)
Source:
ioplatform.scala