mirror of
https://github.com/RGBCube/serenity
synced 2025-07-25 06:07:34 +00:00
LibCore: Add documentation to Stream functions + make parameter clearer
file_size was not very clear about what it was being used for, so I switched it to say expected_file_size to make it clear that it's just a heuristic.
This commit is contained in:
parent
6a4934a030
commit
d3979b0bbd
2 changed files with 10 additions and 2 deletions
|
@ -52,7 +52,7 @@ ErrorOr<ByteBuffer> Stream::read_all(size_t block_size)
|
||||||
return read_all_impl(block_size);
|
return read_all_impl(block_size);
|
||||||
}
|
}
|
||||||
|
|
||||||
ErrorOr<ByteBuffer> Stream::read_all_impl(size_t block_size, size_t file_size)
|
ErrorOr<ByteBuffer> Stream::read_all_impl(size_t block_size, size_t expected_file_size)
|
||||||
{
|
{
|
||||||
ByteBuffer data;
|
ByteBuffer data;
|
||||||
data.ensure_capacity(file_size);
|
data.ensure_capacity(file_size);
|
||||||
|
|
|
@ -37,6 +37,9 @@ public:
|
||||||
/// Tries to fill the entire buffer through reading. Returns whether the
|
/// Tries to fill the entire buffer through reading. Returns whether the
|
||||||
/// buffer was filled without an error.
|
/// buffer was filled without an error.
|
||||||
virtual bool read_or_error(Bytes);
|
virtual bool read_or_error(Bytes);
|
||||||
|
/// Reads the stream until EOF, storing the contents into a ByteBuffer which
|
||||||
|
/// is returned once EOF is encountered. The block size determines the size
|
||||||
|
/// of newly allocated chunks while reading.
|
||||||
virtual ErrorOr<ByteBuffer> read_all(size_t block_size = 4096);
|
virtual ErrorOr<ByteBuffer> read_all(size_t block_size = 4096);
|
||||||
|
|
||||||
virtual bool is_writable() const { return false; }
|
virtual bool is_writable() const { return false; }
|
||||||
|
@ -64,7 +67,12 @@ public:
|
||||||
}
|
}
|
||||||
|
|
||||||
protected:
|
protected:
|
||||||
ErrorOr<ByteBuffer> read_all_impl(size_t block_size, size_t file_size = 0);
|
/// Provides a default implementation of read_all that works for streams
|
||||||
|
/// that behave like POSIX file descriptors. expected_file_size can be
|
||||||
|
/// passed as a heuristic for what the Stream subclass expects the file
|
||||||
|
/// content size to be in order to reduce allocations (does not affect
|
||||||
|
/// actual reading).
|
||||||
|
ErrorOr<ByteBuffer> read_all_impl(size_t block_size, size_t expected_file_size = 0);
|
||||||
};
|
};
|
||||||
|
|
||||||
enum class SeekMode {
|
enum class SeekMode {
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue