file/io.matthewnelson.kmp.file/write

write

fun File.write(excl: OpenExcl?, appending: Boolean, data: Buffer)(source)

Writes the contents of a Buffer to the file associated with the abstract pathname.

docs

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.

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

If Node.js is not being used.

inline fun File.write(excl: OpenExcl?, data: Buffer)(source)

Writes the contents of a Buffer to the file associated with the abstract pathname. The File will be truncated if it exists.

docs

Parameters

excl

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

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

If Node.js is not being used.

fun File.write(excl: OpenExcl?, appending: Boolean, src: ByteBuffer): Int(source)

Writes the remaining contents of src to the file.

Return

The number of bytes written to the file.

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.

src

of bytes to write.

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.

inline fun File.write(excl: OpenExcl?, src: ByteBuffer): Int(source)

Writes the remaining contents of src to the file. The File will be truncated if it exists.

Return

The number of bytes written to the file.

Parameters

excl

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

src

of bytes to write.

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.

Generated by Dokka
© 2023-2025 Copyright Matthew Nelson