Package org.apache.pekko.stream.scaladsl

Class FileIO$

java.lang.Object

org.apache.pekko.stream.scaladsl.FileIO$

public class FileIO$
extends Object

Factories to create sinks and sources from files

Field Summary

Fields

Modifier and Type	Field	Description
static final FileIO$	MODULE$	Static reference to the singleton instance of this Scala object.

Constructor Summary

Constructors

Constructor	Description
FileIO$()

Method Summary

Modifier and Type	Method	Description
Source<ByteString,scala.concurrent.Future<IOResult>>	fromPath(Path f, int chunkSize)	Creates a Source from a files contents.
Source<ByteString,scala.concurrent.Future<IOResult>>	fromPath(Path f, int chunkSize, long startPosition)	Creates a Source from a files contents.
int	fromPath$default$2()
Sink<ByteString,scala.concurrent.Future<IOResult>>	toPath(Path f, scala.collection.immutable.Set<OpenOption> options)	Creates a Sink which writes incoming pekko.util.ByteString elements to the given file path.
Sink<ByteString,scala.concurrent.Future<IOResult>>	toPath(Path f, scala.collection.immutable.Set<OpenOption> options, long startPosition)	Creates a Sink which writes incoming pekko.util.ByteString elements to the given file path.
scala.collection.immutable.Set<OpenOption>	toPath$default$2()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MODULE$

public static final FileIO$ MODULE$

Static reference to the singleton instance of this Scala object.

Constructor Details

FileIO$

public FileIO$()

Method Details

fromPath

public Source<ByteString,scala.concurrent.Future<IOResult>> fromPath(Path f,
 int chunkSize)

Creates a Source from a files contents. Emitted elements are chunkSize sized pekko.util.ByteString elements, except the final element, which will be up to chunkSize in size.

You can configure the default dispatcher for this Source by changing the pekko.stream.materializer.blocking-io-dispatcher or set it for a given Source by using pekko.stream.ActorAttributes.

It materializes a Future of IOResult containing the number of bytes read from the source file upon completion, and a possible exception if IO operation was not completed successfully. Note that bytes having been read by the source does not give any guarantee that the bytes were seen by downstream stages.

Parameters:

f - the file path to read from

chunkSize - the size of each read operation, defaults to 8192

fromPath

public Source<ByteString,scala.concurrent.Future<IOResult>> fromPath(Path f,
 int chunkSize,
 long startPosition)

Creates a Source from a files contents. Emitted elements are chunkSize sized pekko.util.ByteString elements, except the final element, which will be up to chunkSize in size.

You can configure the default dispatcher for this Source by changing the pekko.stream.materializer.blocking-io-dispatcher or set it for a given Source by using pekko.stream.ActorAttributes.

It materializes a Future of IOResult containing the number of bytes read from the source file upon completion, and a possible exception if IO operation was not completed successfully. Note that bytes having been read by the source does not give any guarantee that the bytes were seen by downstream stages.

Parameters:

f - the file path to read from

chunkSize - the size of each read operation, defaults to 8192

startPosition - the start position to read from

fromPath$default$2

public int fromPath$default$2()

toPath

public Sink<ByteString,scala.concurrent.Future<IOResult>> toPath(Path f,
 scala.collection.immutable.Set<OpenOption> options)

Creates a Sink which writes incoming pekko.util.ByteString elements to the given file path. Overwrites existing files by truncating their contents as default.

Materializes a Future of IOResult that will be completed with the size of the file (in bytes) at the streams completion, and a possible exception if IO operation was not completed successfully.

This source is backed by an Actor which will use the dedicated pekko.stream.blocking-io-dispatcher, unless configured otherwise by using pekko.stream.ActorAttributes.

Accepts as arguments a set of StandardOpenOption, which will determine the underlying behavior when writing the file. If java.nio.file.StandardOpenOption.SYNC is provided, every update to the file's content be written synchronously to the underlying storage device. Otherwise (the default), the write will be written to the storage device asynchronously by the OS, and may not be stored durably on the storage device at the time the stream completes.

Parameters:

f - the file path to write to

options - File open options, see StandardOpenOption, defaults to Set(WRITE, TRUNCATE_EXISTING, CREATE)

toPath

public Sink<ByteString,scala.concurrent.Future<IOResult>> toPath(Path f,
 scala.collection.immutable.Set<OpenOption> options,
 long startPosition)

Creates a Sink which writes incoming pekko.util.ByteString elements to the given file path. Overwrites existing files by truncating their contents as default.

Materializes a Future of IOResult that will be completed with the size of the file (in bytes) at the streams completion, and a possible exception if IO operation was not completed successfully.

This source is backed by an Actor which will use the dedicated pekko.stream.blocking-io-dispatcher, unless configured otherwise by using pekko.stream.ActorAttributes.

Accepts as arguments a set of StandardOpenOption, which will determine the underlying behavior when writing the file. If java.nio.file.StandardOpenOption.SYNC is provided, every update to the file's content be written synchronously to the underlying storage device. Otherwise (the default), the write will be written to the storage device asynchronously by the OS, and may not be stored durably on the storage device at the time the stream completes.

Parameters:

f - the file path to write to

options - File open options, see StandardOpenOption, defaults to Set(WRITE, CREATE)

startPosition - the start position to write to

toPath$default$2

public scala.collection.immutable.Set<OpenOption> toPath$default$2()