mirror of
https://github.com/pocoproject/poco.git
synced 2024-12-13 10:32:57 +01:00
#2821: Poco::Buffer: full on creation? - add documentation describing the behavior.
This commit is contained in:
parent
b6dcb5bbd3
commit
2daf323afc
@ -34,6 +34,21 @@ class Buffer
|
||||
///
|
||||
/// This class is useful everywhere where a temporary buffer
|
||||
/// is needed.
|
||||
///
|
||||
/// Note: A Buffer has both a size and a capacity, similar to
|
||||
/// std::vector and std::string. However, upon creation of the
|
||||
/// Buffer, the size always equals the capacity (provided via the
|
||||
/// length argument of the constructor), as the Buffer is meant
|
||||
/// to be filled by directly writing to its contents,
|
||||
/// i.e., by passing the pointer to the first element
|
||||
/// of the buffer obtained via begin() to a function expecting
|
||||
/// a pointer to a buffer.
|
||||
///
|
||||
/// Therefore, calling append() on a newly created Buffer will
|
||||
/// always expand the buffer size and capacity.
|
||||
/// If you need to create a Buffer and want to write data to it
|
||||
/// by calling append(), the correct steps are to first create
|
||||
/// the Buffer, then call resize(0), and then call append().
|
||||
{
|
||||
public:
|
||||
Buffer(std::size_t length):
|
||||
|
Loading…
Reference in New Issue
Block a user