#include <FileOutputStream.h>
An output stream that writes into a local file.
- See also
- OutputStream, FileInputStream, File::createOutputStream
◆ FileOutputStream()
| water::FileOutputStream::FileOutputStream |
( |
const File & | fileToWriteTo, |
|
|
size_t | bufferSizeToUse = 16384 ) |
Creates a FileOutputStream.
If the file doesn't exist, it will first be created. If the file can't be created or opened (for example, because the parent directory of the file does not exist), the failedToOpen() method will return true.
If the file already exists when opened, the stream's write-position will be set to the end of the file. To overwrite an existing file, use File::deleteFile() before opening the stream, or use setPosition(0) after it's opened (although this won't truncate the file).
Destroying a FileOutputStream object does not force the operating system to write the buffered data to disk immediately. If this is required you should call flush() before triggering the destructor.
- See also
- TemporaryFile
◆ ~FileOutputStream()
| water::FileOutputStream::~FileOutputStream |
( |
| ) |
|
◆ closeHandle()
| void water::FileOutputStream::closeHandle |
( |
| ) |
|
|
private |
◆ failedToOpen()
| bool water::FileOutputStream::failedToOpen |
( |
| ) |
const |
|
inlinenoexcept |
Returns true if the stream couldn't be opened for some reason.
- See also
- getResult()
◆ flush()
| void water::FileOutputStream::flush |
( |
| ) |
|
|
overridevirtual |
If the stream is using a buffer, this will ensure it gets written out to the destination.
Implements water::OutputStream.
◆ flushBuffer()
| bool water::FileOutputStream::flushBuffer |
( |
| ) |
|
|
private |
◆ flushInternal()
| void water::FileOutputStream::flushInternal |
( |
| ) |
|
|
private |
◆ getFile()
| const File & water::FileOutputStream::getFile |
( |
| ) |
const |
|
inline |
Returns the file that this stream is writing to.
◆ getPosition()
| int64 water::FileOutputStream::getPosition |
( |
| ) |
|
|
overridevirtual |
◆ getStatus()
| const Result & water::FileOutputStream::getStatus |
( |
| ) |
const |
|
inlinenoexcept |
Returns the status of the file stream. The result will be ok if the file opened successfully. If an error occurs while opening or writing to the file, this will contain an error message.
◆ openedOk()
| bool water::FileOutputStream::openedOk |
( |
| ) |
const |
|
inlinenoexcept |
Returns true if the stream opened without problems.
- See also
- getResult()
◆ openHandle()
| void water::FileOutputStream::openHandle |
( |
| ) |
|
|
private |
◆ setPosition()
| bool water::FileOutputStream::setPosition |
( |
int64 | newPosition | ) |
|
|
overridevirtual |
Tries to move the stream's output position.
Not all streams will be able to seek to a new position - this will return false if it fails to work.
- See also
- getPosition
Implements water::OutputStream.
◆ setPositionInternal()
| int64 water::FileOutputStream::setPositionInternal |
( |
int64 | | ) |
|
|
private |
◆ truncate()
| Result water::FileOutputStream::truncate |
( |
| ) |
|
Attempts to truncate the file to the current write position. To truncate a file to a specific size, first use setPosition() to seek to the appropriate location, and then call this method.
◆ write()
| bool water::FileOutputStream::write |
( |
const void * | dataToWrite, |
|
|
size_t | numberOfBytes ) |
|
overridevirtual |
Writes a block of data to the stream.
When creating a subclass of OutputStream, this is the only write method that needs to be overloaded - the base class has methods for writing other types of data which use this to do the work.
- Parameters
-
| dataToWrite | the target buffer to receive the data. This must not be null. |
| numberOfBytes | the number of bytes to write. |
- Returns
- false if the write operation fails for some reason
Implements water::OutputStream.
◆ writeInternal()
| ssize_t water::FileOutputStream::writeInternal |
( |
const void * | data, |
|
|
size_t | numBytes ) |
|
private |
◆ writeRepeatedByte()
| bool water::FileOutputStream::writeRepeatedByte |
( |
uint8 | byte, |
|
|
size_t | numTimesToRepeat ) |
|
overridevirtual |
Writes a byte to the output stream a given number of times.
- Returns
- false if the write operation fails for some reason
Reimplemented from water::OutputStream.
◆ buffer
| HeapBlock<char> water::FileOutputStream::buffer |
|
private |
◆ bufferSize
| size_t water::FileOutputStream::bufferSize |
|
private |
◆ bytesInBuffer
| size_t water::FileOutputStream::bytesInBuffer |
|
private |
◆ currentPosition
| int64 water::FileOutputStream::currentPosition |
|
private |
◆ file
| File water::FileOutputStream::file |
|
private |
◆ fileHandle
| void* water::FileOutputStream::fileHandle |
|
private |
◆ status
| Result water::FileOutputStream::status |
|
private |
The documentation for this class was generated from the following files:
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/water/files/FileOutputStream.h
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/water/files/FileOutputStream.cpp
1.16.1