BloombergLP::bdlsb::FixedMemOutStreamBuf

This class implements the output functionality of the basic_streambuf protocol for client-supplied memory.

Synopsis

Declared in <bdlsb_fixedmemoutstreambuf.h>

class FixedMemOutStreamBuf
    : public std::streambuf

Base Classes

NameDescription
std::streambuf

Member Functions

NameDescription
FixedMemOutStreamBuf [constructor]Create an empty stream buffer that uses the specified character buffer of the specified length. The behavior is undefined unless length == 0 or length > 0 && buffer != 0. Note that buffer is held but not owned.
~FixedMemOutStreamBuf [destructor] [virtual]Destroy this stream buffer.
capacity Return the number of characters in the buffer held by this stream buffer. See length, below, for the span of bytes actually written.
data Return a pointer providing modifiable access to the character buffer held by this stream buffer (supplied at construction).
data Return a pointer providing non-modifiable access to the character buffer held by this stream buffer (supplied at construction).
length Return the number of characters from the beginning of the buffer to the current write position. This function returns the same value as seekoff(0, bsl::ios_base::end). The length is modified by a call to seekpos or seekoff and reset to zero by a call to pubsetbuf.

Protected Member Functions

NameDescription
seekoff [virtual]Set the position indicator to the relative specified offset from the base position indicated by the specified fixedPosition and return the resulting absolute position on success or pos_type(-1) on failure. Optionally specify which area of the stream buffer. The seek operation will fail if which does not include the flag bsl::ios_base::out or if the resulting absolute position is less than zero or greater than the value returned by length.
seekpos [virtual]Set the position indicator to the specified position and return the resulting absolute position on success or pos_type(-1) on failure. Optionally specify which area of the stream buffer. The seekpos operation will fail if which does not include the flag bsl::ios_base::out or if position is less then zero or greater than the value returned by length.
setbuf [virtual]