IO.File

(in ./Carbon/IO.lua)

Exposes object-oriented filesystem access. See IO for more methods.


Methods

object public File:Close()

Returns void

Closes the file.


object public File:Read()

Returns void

Reads the entire contents of the file.


object public File:ReadBufferAsync([list<string> into])

Returns Promise<list<string>>

  • optional into: A list to write the output into instead of creating a new buffer.

Reads a file and amortizes its loading through an event loop. Returns the raw buffer, containing a series of strings.


object public File:ReadBufferAsync()

Returns Promise<string>

Reads a file and amortizes its loading through an event loop. The same as File:ReadAsync()


object public File:Write(string contents)

Returns void

  • required contents: The file contents

Writes to the file.


Properties

[none]