file/io.matthewnelson.kmp.file/openWrite

openWrite

fun File.openWrite(excl: OpenExcl?, appending: Boolean): FileStream.Write(source)

Opens a File for write operations.

e.g.

"/path/to/my/file".toFile().openWrite(excl = null, false).use { s ->
    // write
}
Content copied to clipboard

Return

A FileStream.Write for write-only operations.

Parameters

excl

The OpenExcl desired for this open operation. If null, then OpenExcl.MaybeCreate.DEFAULT will be used.

appending

If true, data written to this file will occur at the end of the file. If false, the file will be truncated if it exists.

See also

Throws

If there was a failure to open the File for the provided excl argument, if the File points to an existing directory, or if the filesystem threw a security exception.

UnsupportedOperationException

On Kotlin/JS-Browser.

inline fun File.openWrite(excl: OpenExcl?): FileStream.Write(source)

Opens a File for write operations. The File will be truncated if it exists.

e.g.

"/path/to/my/file".toFile().openWrite(excl = null).use { s ->
    // write
}
Content copied to clipboard

Return

A FileStream.Write for write-only operations.

Parameters

excl

The OpenExcl desired for this open operation. If null, then OpenExcl.MaybeCreate.DEFAULT will be used.

See also

Throws

If there was a failure to open the File for the provided excl argument, if the File points to an existing directory, or if the filesystem threw a security exception.

UnsupportedOperationException

On Kotlin/JS-Browser.