Class FileIO$
- java.lang.Object
-
- akka.stream.scaladsl.FileIO$
-
public class FileIO$ extends java.lang.Object
Creates a Source from a files contents. Emitted elements arechunkSize
sizedByteString
elements, except the final element, which will be up tochunkSize
in size.You can configure the default dispatcher for this Source by changing the
akka.stream.materializer.blocking-io-dispatcher
or set it for a given Source by usingActorAttributes
.It materializes a
Future
ofIOResult
containing the number of bytes read from the source file upon completion, and a possible exception if IO operation was not completed successfully.param: f the file to read from param: chunkSize the size of each read operation, defaults to 8192
-
-
Constructor Summary
Constructors Constructor Description FileIO$()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Source<ByteString,scala.concurrent.Future<IOResult>>
fromFile(java.io.File f, int chunkSize)
Deprecated.Use `fromPath` instead.int
fromFile$default$2()
Source<ByteString,scala.concurrent.Future<IOResult>>
fromPath(java.nio.file.Path f, int chunkSize)
Creates a Source from a files contents.Source<ByteString,scala.concurrent.Future<IOResult>>
fromPath(java.nio.file.Path f, int chunkSize, long startPosition)
Creates a Source from a files contents.int
fromPath$default$2()
Sink<ByteString,scala.concurrent.Future<IOResult>>
toFile(java.io.File f, scala.collection.immutable.Set<java.nio.file.OpenOption> options)
Deprecated.Use `toPath` instead.scala.collection.immutable.Set<java.nio.file.OpenOption>
toFile$default$2()
Sink<ByteString,scala.concurrent.Future<IOResult>>
toPath(java.nio.file.Path f, scala.collection.immutable.Set<java.nio.file.OpenOption> options)
Creates a Sink which writes incomingByteString
elements to the given file path.Sink<ByteString,scala.concurrent.Future<IOResult>>
toPath(java.nio.file.Path f, scala.collection.immutable.Set<java.nio.file.OpenOption> options, long startPosition)
Creates a Sink which writes incomingByteString
elements to the given file path.scala.collection.immutable.Set<java.nio.file.OpenOption>
toPath$default$2()
-
-
-
Field Detail
-
MODULE$
public static final FileIO$ MODULE$
Static reference to the singleton instance of this Scala object.
-
-
Method Detail
-
fromFile
public Source<ByteString,scala.concurrent.Future<IOResult>> fromFile(java.io.File f, int chunkSize)
Deprecated.Use `fromPath` instead. Since 2.4.5.
-
fromFile$default$2
public int fromFile$default$2()
-
fromPath
public Source<ByteString,scala.concurrent.Future<IOResult>> fromPath(java.nio.file.Path f, int chunkSize)
Creates a Source from a files contents. Emitted elements arechunkSize
sizedByteString
elements, except the final element, which will be up tochunkSize
in size.You can configure the default dispatcher for this Source by changing the
akka.stream.materializer.blocking-io-dispatcher
or set it for a given Source by usingActorAttributes
.It materializes a
Future
ofIOResult
containing the number of bytes read from the source file upon completion, and a possible exception if IO operation was not completed successfully.- Parameters:
f
- the file path to read fromchunkSize
- the size of each read operation, defaults to 8192- Returns:
- (undocumented)
-
fromPath
public Source<ByteString,scala.concurrent.Future<IOResult>> fromPath(java.nio.file.Path f, int chunkSize, long startPosition)
Creates a Source from a files contents. Emitted elements arechunkSize
sizedByteString
elements, except the final element, which will be up tochunkSize
in size.You can configure the default dispatcher for this Source by changing the
akka.stream.materializer.blocking-io-dispatcher
or set it for a given Source by usingActorAttributes
.It materializes a
Future
ofIOResult
containing the number of bytes read from the source file upon completion, and a possible exception if IO operation was not completed successfully.- Parameters:
f
- the file path to read fromchunkSize
- the size of each read operation, defaults to 8192startPosition
- the start position to read from- Returns:
- (undocumented)
-
fromPath$default$2
public int fromPath$default$2()
-
toFile
public Sink<ByteString,scala.concurrent.Future<IOResult>> toFile(java.io.File f, scala.collection.immutable.Set<java.nio.file.OpenOption> options)
Deprecated.Use `toPath` instead. Since 2.4.5.Creates a Sink which writes incomingByteString
elements to the given file. Overwrites existing files by truncating their contents as default.Materializes a
Future
ofIOResult
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
akka.stream.blocking-io-dispatcher
, unless configured otherwise by usingActorAttributes
.- Parameters:
f
- the file to write tooptions
- File open options, seeStandardOpenOption
, defaults to Set(WRITE, TRUNCATE_EXISTING, CREATE)- Returns:
- (undocumented)
-
toFile$default$2
public scala.collection.immutable.Set<java.nio.file.OpenOption> toFile$default$2()
-
toPath
public Sink<ByteString,scala.concurrent.Future<IOResult>> toPath(java.nio.file.Path f, scala.collection.immutable.Set<java.nio.file.OpenOption> options)
Creates a Sink which writes incomingByteString
elements to the given file path. Overwrites existing files by truncating their contents as default.Materializes a
Future
ofIOResult
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
akka.stream.blocking-io-dispatcher
, unless configured otherwise by usingActorAttributes
.Accepts as arguments a set of
StandardOpenOption
, which will determine the underlying behavior when writing the file. Ifjava.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 tooptions
- File open options, seeStandardOpenOption
, defaults to Set(WRITE, TRUNCATE_EXISTING, CREATE)- Returns:
- (undocumented)
-
toPath
public Sink<ByteString,scala.concurrent.Future<IOResult>> toPath(java.nio.file.Path f, scala.collection.immutable.Set<java.nio.file.OpenOption> options, long startPosition)
Creates a Sink which writes incomingByteString
elements to the given file path. Overwrites existing files by truncating their contents as default.Materializes a
Future
ofIOResult
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
akka.stream.blocking-io-dispatcher
, unless configured otherwise by usingActorAttributes
.Accepts as arguments a set of
StandardOpenOption
, which will determine the underlying behavior when writing the file. Ifjava.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 tooptions
- File open options, seeStandardOpenOption
, defaults to Set(WRITE, CREATE)startPosition
- the start position to write to- Returns:
- (undocumented)
-
toPath$default$2
public scala.collection.immutable.Set<java.nio.file.OpenOption> toPath$default$2()
-
-