Packages

package io

Provides various ways to work with streams that perform IO.

Source
io.scala
Linear Supertypes
ioplatform, iojvmnative, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. io
  2. ioplatform
  3. iojvmnative
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package file

    Provides support for working with files.

  2. package net

    Provides support for doing network I/O -- TCP, UDP, and TLS.

Type Members

  1. type ClosedChannelException = java.nio.channels.ClosedChannelException
    Definition Classes
    iojvmnative
  2. type IOException = java.io.IOException
  3. type InterruptedIOException = java.io.InterruptedIOException
    Definition Classes
    iojvmnative
  4. 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 readClassLoaderResource[F[_]](name: String, chunkSize: Int = 64 * 1024, classLoader: ClassLoader = getClass().getClassLoader())(implicit F: Sync[F]): Stream[F, Byte]

    Stream of bytes read asynchronously from the specified classloader resource.

    Stream of bytes read asynchronously from the specified classloader resource.

    Definition Classes
    iojvmnative
    See also

    readClassResource for a resource relative to a class.

  2. def readClassResource[F[_], C](name: String, chunkSize: Int = 64 * 1024)(implicit F: Sync[F], ct: ClassTag[C]): Stream[F, Byte]

    Stream of bytes read asynchronously from the specified resource relative to the class C.

    Stream of bytes read asynchronously from the specified resource relative to the class C.

    Definition Classes
    iojvmnative
    See also

    readClassLoaderResource for a resource relative to a classloader.

  3. 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.

  4. def readOutputStream[F[_]](chunkSize: Int)(f: (OutputStream) => F[Unit])(implicit arg0: Async[F]): Stream[F, Byte]

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

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

    The stream produced by this will terminate if:

    • f returns
    • f calls OutputStream#close

    If none of those happens, the stream will run forever.

    Definition Classes
    ioplatform
  5. def stderr[F[_]](implicit arg0: Sync[F]): Pipe[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.

    Definition Classes
    iojvmnative
  6. def stdin[F[_]](bufSize: Int)(implicit F: Async[F]): Stream[F, Byte]

    Stream of bytes read asynchronously from standard input.

    Stream of bytes read asynchronously from standard input.

    Definition Classes
    ioplatform
  7. def stdinUtf8[F[_]](bufSize: Int)(implicit arg0: Async[F]): 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.

    Definition Classes
    ioplatform
  8. def stdout[F[_]](implicit arg0: Sync[F]): Pipe[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.

    Definition Classes
    iojvmnative
  9. def stdoutLines[F[_], O](charset: Charset = StandardCharsets.UTF_8)(implicit arg0: Sync[F], arg1: Show[O]): Pipe[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.

    Definition Classes
    iojvmnative
  10. def toInputStream[F[_]](implicit arg0: Async[F]): Pipe[F, Byte, InputStream]

    Pipe that converts a stream of bytes to a stream that will emit 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 emit 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 effect.

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

    Definition Classes
    ioplatform
  11. def toInputStreamResource[F[_]](source: Stream[F, Byte])(implicit arg0: Async[F]): Resource[F, InputStream]

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

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

    Definition Classes
    ioplatform
  12. 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.

  13. def writeOutputStream[F[_]](fos: F[OutputStream], closeAfterUse: Boolean = true)(implicit F: Sync[F]): Pipe[F, Byte, Nothing]

    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.

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

  14. object Watcher
  15. object compression extends compressionplatform

Deprecated Value Members

  1. def stdin[F[_]](bufSize: Int, F: Sync[F]): Stream[F, Byte]
    Definition Classes
    ioplatform
    Annotations
    @deprecated
    Deprecated

    (Since version 3.5.0) Use overload with Async, which is cancelable

  2. def stdinUtf8[F[_]](bufSize: Int, F: Sync[F]): Stream[F, String]
    Definition Classes
    ioplatform
    Annotations
    @deprecated
    Deprecated

    (Since version 3.5.0) Use overload with Async, which is cancelable

Inherited from ioplatform

Inherited from iojvmnative

Inherited from AnyRef

Inherited from Any

Ungrouped