Packages

  • package root
    Definition Classes
    root
  • package fs2
    Definition Classes
    root
  • package io

    Provides various ways to work with streams that perform IO.

    Provides various ways to work with streams that perform IO.

    Definition Classes
    fs2
  • package file

    Provides support for working with files.

  • package tcp

    Provides support for TCP networking.

  • package udp

    Provides support for UDP networking.

  • Watcher
p

fs2

io

package io

Provides various ways to work with streams that perform IO.

Source
io.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. io
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. sealed abstract class Watcher [F[_]] extends AnyRef

    Allows watching the file system for changes to directories and files by using the platform's WatchService.

Value Members

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

    Reads all bytes from the specified InputStream with a buffer size of chunkSize.

    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.

    Blocks the current thread.

  2. def readInputStreamAsync[F[_]](fis: F[InputStream], chunkSize: Int, closeAfterUse: Boolean = true)(implicit F: Effect[F], ec: ExecutionContext): Stream[F, Byte]

    Reads all bytes from the specified InputStream with a buffer size of chunkSize.

    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.

    This will block a thread in the ExecutionContext, so the size of any associated threadpool should be sized appropriately.

  3. def stdin[F[_]](bufSize: Int)(implicit F: Sync[F]): Stream[F, Byte]

    Stream of bytes read from standard input.

  4. def stdinAsync[F[_]](bufSize: Int)(implicit F: Effect[F], ec: ExecutionContext): Stream[F, Byte]

    Stream of bytes read asynchronously from standard input.

  5. def stdout[F[_]](implicit F: Sync[F]): Sink[F, Byte]

    Sink of bytes that writes emitted values to standard output.

  6. def stdoutAsync[F[_]](implicit F: Effect[F], ec: ExecutionContext): Sink[F, Byte]

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

  7. def toInputStream[F[_]](implicit F: Effect[F], ec: ExecutionContext): Pipe[F, Byte, InputStream]

    Pipe that converts a stream of bytes to a stream that will emits a single java.io.InputStream, that is closed whenever the resulting stream terminates.

    Pipe that converts a stream of bytes to a stream that will emits a single java.io.InputStream, that is closed whenever the resulting stream terminates.

    If the close of resulting input stream is invoked manually, then this will await until the original stream completely terminates.

    Because all InputStream methods block (including close), the resulting InputStream should be consumed on a different thread pool than the one that is backing the ExecutionContext.

    Note that the implementation is not thread safe -- only one thread is allowed at any time to operate on the resulting java.io.InputStream.

  8. def unsafeReadInputStream[F[_]](fis: F[InputStream], chunkSize: Int, closeAfterUse: Boolean = true)(implicit F: Sync[F]): Stream[F, Byte]

    Reads all bytes from the specified InputStream with a buffer size of chunkSize.

    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.

    Blocks the current thread.

  9. def unsafeReadInputStreamAsync[F[_]](fis: F[InputStream], chunkSize: Int, closeAfterUse: Boolean = true)(implicit F: Effect[F], ec: ExecutionContext): Stream[F, Byte]

    Reads all bytes from the specified InputStream with a buffer size of chunkSize.

    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.

    This will block a thread in the ExecutionContext, so the size of any associated threadpool should be sized appropriately.

    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.

  10. def writeOutputStream[F[_]](fos: F[OutputStream], closeAfterUse: Boolean = true)(implicit arg0: Sync[F]): Sink[F, Byte]

    Writes all bytes to the specified OutputStream.

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

    Blocks the current thread.

  11. def writeOutputStreamAsync[F[_]](fos: F[OutputStream], closeAfterUse: Boolean = true)(implicit F: Effect[F], ec: ExecutionContext): Sink[F, Byte]

    Writes all bytes to the specified OutputStream.

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

    This will block a thread in the ExecutorService, so the size of any associated threadpool should be sized appropriately.

  12. object Watcher

Inherited from AnyRef

Inherited from Any

Ungrouped