Packages

p

fs2

io

package io

Provides various ways to work with streams that perform IO.

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

Type Members

  1. class ClosedChannelException extends IOException
  2. trait Duplex extends Object with Readable with Writable

    A facade for Node.js stream.Duplex.

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

    Annotations
    @JSType() @native()
    See also

    https://nodejs.org/api/stream.html

  3. type IOException = java.io.IOException
  4. class InterruptedIOException extends IOException
  5. trait Readable extends Object

    A facade for Node.js stream.Readable.

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

    Annotations
    @JSType() @native()
    See also

    https://nodejs.org/api/stream.html

  6. final class StreamDestroyedException extends IOException
  7. trait Writable extends Object

    A facade for Node.js stream.Writable.

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

    Annotations
    @JSType() @native()
    See also

    https://nodejs.org/api/stream.html

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.

  2. def readWritable[F[_]](f: (Writable) ⇒ F[Unit])(implicit arg0: Async[F]): 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

    Definition Classes
    ioplatform
  3. def stderr[F[_]](implicit arg0: Async[F]): Pipe[F, Byte, INothing]

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

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

    Definition Classes
    ioplatform
  4. def stdin[F[_]](ignored: Int)(implicit arg0: Async[F]): Stream[F, Byte]

    Stream of bytes read asynchronously from standard input.

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

    Definition Classes
    ioplatform
    Annotations
    @nowarn()
  5. def stdin[F[_]](implicit arg0: Async[F]): Stream[F, Byte]

    Stream of bytes read asynchronously from standard input.

    Stream of bytes read asynchronously from standard input.

    Definition Classes
    ioplatform
  6. def stdinUtf8[F[_]](ignored: 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. Takes a dummy Int parameter for source-compatibility with JVM.

    Definition Classes
    ioplatform
    Annotations
    @nowarn()
  7. def stdinUtf8[F[_]](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: Async[F]): Pipe[F, Byte, INothing]

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

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

    Definition Classes
    ioplatform
  9. def stdoutLines[F[_], O](charset: Charset = StandardCharsets.UTF_8)(implicit arg0: Async[F], arg1: Show[O]): Pipe[F, O, INothing]

    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
    ioplatform
  10. def suspendReadableAndRead[F[_], R <: Readable](destroyIfNotEnded: Boolean = true, destroyIfCanceled: Boolean = true)(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.

    Definition Classes
    ioplatform
  11. def toDuplexAndRead[F[_]](f: (Duplex) ⇒ F[Unit])(implicit arg0: Async[F]): Pipe[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

    Definition Classes
    ioplatform
  12. def toReadable[F[_]](implicit F: Async[F]): Pipe[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.

    Definition Classes
    ioplatform
  13. def toReadableResource[F[_]](s: Stream[F, Byte])(implicit arg0: Async[F]): Resource[F, Readable]

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

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

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

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

    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.

  16. def writeWritable[F[_]](writable: F[Writable], endAfterUse: Boolean = true)(implicit F: Async[F]): Pipe[F, Byte, INothing]

    Writes all bytes to the specified Writable.

    Writes all bytes to the specified Writable.

    Definition Classes
    ioplatform
  17. object IOException
  18. object InterruptedIOException extends Serializable
  19. object compression extends compressionplatform

Deprecated Value Members

  1. def readReadable[F[_]](readable: F[Readable], destroyIfNotEnded: Boolean = true, destroyIfCanceled: Boolean = true)(implicit F: Async[F]): Stream[F, Byte]
    Definition Classes
    ioplatform
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.4) Use suspendReadableAndRead instead

Inherited from ioplatform

Inherited from AnyRef

Inherited from Any

Ungrouped