This class, like bdlsb::OverflowMemOutStreamBuf, implements the output functionality of the bsl::basic_streambuf interface, using a client‐supplied buffer and allocator‐supplied overflow buffer if additional memory is needed. It has an interface similar to bdlsb::OverflowMemOutStreamBuf but does not inherit from bsl::streambuf. Thus, it is suitable for use as template parameter to bslx::GenericByteOutStream (but not to bslx::ByteOutStream or bslx::ByteOutStreamFormatter). Note that this class is not designed to be derived from.

Synopsis

Declared in <bdlsb_overflowmemoutput.h>

class OverflowMemOutput;

Type Aliases

Name

char_type

int_type

off_type

pos_type

traits_type

Member Functions

Name

Description

OverflowMemOutput [constructor]

Create an OverflowMemOutput using the specified buffer of the specified length as the initial output buffer. Optionally specify a basicAllocator used to supply memory. If basicAllocator is 0, the currently installed default allocator is used. The behavior is undefined unless buffer != 0 && length > 0. Note that this stream buffer does not assume ownership of buffer.

~OverflowMemOutput [destructor]

Destroy this stream buffer.

dataLength

Return the number of bytes that have been written to this object.

dataLengthInInitialBuffer

Return the length of data in the initial buffer, i.e., dataLength() if there is no overflow buffer, or initialBufferSize() if there is one.

dataLengthInOverflowBuffer

Return the length of the data in the overflow buffer, i.e., 0 if there is no overflow buffer, or dataLength() ‐ initialBufferSize() if there is one.

initialBuffer

Return a pointer providing non‐modifiable access to the character buffer held by this stream buffer (specified at construction).

initialBufferSize

Return the size of the initial buffer held by this stream buffer.

overflowBuffer

Return a pointer providing non‐modifiable access to the overflow buffer if there is one, or 0 otherwise.

overflowBufferSize

Return the size of the overflow buffer, or 0 if there is no overflow buffer.

pubseekoff

Set the position indicator to the relative specified offset from the base position indicated by the specified way 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.

pubseekpos

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.

pubsetbuf

Reinitialize this stream buffer to use the specified character buffer having the specified length. Return a pointer providing modifiable access to this stream buffer. This stream buffer does not support reinitialization of the internal character buffer.

pubsync

Synchronize this stream buffer with associated character sequence. Operation has no effect. Return 0 unconditionally.

sputc

Write the specified character c at the current write position and advance write position of this buffer. Return c, or traits_type::eof() if the end of the write buffer is reached.

sputn

Write the specified length characters from the specified source to this buffer. Return the number of characters written, which is either length or the distance from the current write position to the end of the write buffer, whichever is smaller, and move the write cursor position by this amount. The behaviour is undefined unless source != 0 || length > 0.

operator BloombergLP::bslmf::NestedTraitDeclaration<OverflowMemOutput, UsesBslmaAllocator>

Created with MrDocs