Creates a file with the given path and, optionally, the given contents. Note that, if contents is specified, it will be mutated by the file!
The file system that created the file.
The stats object for the given file. PreloadFile will mutate this object. Note that this object must contain the appropriate mode that the file was opened as.
A buffer containing the entire contents of the file. PreloadFile will mutate this buffer. If not specified, we assume it is a new file.
Advance the current file position by the indicated number of positions.
Asynchronous fchmod.
Asynchronous fchmod.
Core: Asynchronous close. Must be implemented by subclasses of this class.
Core: Synchronous close.
NONSTANDARD: Get the underlying buffer for this file. !!DO NOT MUTATE!! Will mess up dirty tracking.
Get the path to this file.
The path to the file.
Get the current file position.
We emulate the following bug mentioned in the Node documentation:
On Linux, positional writes don't work when the file is opened in append mode. The kernel ignores the position argument and always appends the data to the end of the file.
The current file position.
NONSTANDARD: Get underlying stats for this file. !!DO NOT MUTATE!!
Read data from the file.
The buffer that the data will be written to.
The offset within the buffer where writing will start.
An integer specifying the number of bytes to read.
An integer specifying where to begin reading from in the file. If position is null, data will be read from the current file position.
The number is the number of bytes read
Read data from the file.
The buffer that the data will be written to.
The offset within the buffer where writing will start.
An integer specifying the number of bytes to read.
An integer specifying where to begin reading from in the file. If position is null, data will be read from the current file position.
Resets the dirty bit. Should only be called after a sync has completed successfully.
Set the file position.
Asynchronous stat.
Synchronous stat.
Core: Asynchronous sync. Must be implemented by subclasses of this class.
Core: Synchronous sync.
Asynchronous truncate.
Synchronous truncate.
Write buffer to the file. Note that it is unsafe to use fs.write multiple times on the same file without waiting for the callback.
Buffer containing the data to write to the file.
Offset in the buffer to start reading data from.
The amount of bytes to write to the file.
Offset from the beginning of the file where this data should be written. If position is null, the data will be written at the current position.
Write buffer to the file. Note that it is unsafe to use fs.writeSync multiple times on the same file without waiting for the callback.
Buffer containing the data to write to the file.
Offset in the buffer to start reading data from.
The amount of bytes to write to the file.
Offset from the beginning of the file where this data should be written. If position is null, the data will be written at the current position.
Generated using TypeDoc
An implementation of the File interface that operates on a file that is completely in-memory. PreloadFiles are backed by a Buffer.
This is also an abstract class, as it lacks an implementation of 'sync' and 'close'. Each filesystem that wishes to use this file representation must extend this class and implement those two methods.
'close' lever that disables functionality once closed.