file/io.matthewnelson.kmp.file/FileStream/Write/position

position

expect abstract override fun position(new: Long): FileStream.Write(source)

NOTE: If isAppending is true, this is silently ignored as data is always written to the end of the File.

NOTE: On Js/WasmJs, if using the :kmp-file:async extension module, this synchronous function can fail to acquire the necessary position lock if an asynchronous FileStream operation is holding it. In that event, an IOException is raised. This is a platform limitation and can be avoided by not intermixing synchronous, and asynchronous functionality.

Return

The Write stream for chaining operations.

Parameters

new

The new position for the Write stream.

Throws

IllegalArgumentException

If new is less than 0.

IOException

If an I/O error occurs, or the stream is closed.

actual abstract override fun position(new: Long): FileStream.Write(source)