This class, like bdlsb::FixedMemOutStreamBuf, implements the output functionality of the basic_streambuf interface, using client‐supplied char * memory. It has an identical interface to bdlsb::FixedMemOutStreamBuf but does not inherit from bsl::streambuf. Thus, it is suitable for use as template parameter to bslx::GenericOutStream (but not to bslx::StreambufOutStream). Note that this class is not designed to be derived from.

Synopsis

Declared in <bdlsb_fixedmemoutput.h>

class FixedMemOutput;

Type Aliases

Name

char_type

int_type

off_type

pos_type

traits_type

Member Functions

Name

Description

FixedMemOutput [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.

capacity

Return the size in bytes of the buffer held by this stream buffer.

data

data overloads

getloc

Return the current default locale. Operation has no effect, because locales are not supported by this component. Return default constructed bsl::locale object.

length

Return the number of characters from the beginning of the buffer to the current write position.

pubimbue

Associate the specified locale loc to this stream buffer. Operation has no effect, because locales are not supported by this component. Return default constructed bsl::locale object.

pubseekoff

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.

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 or greater than the value returned by length.

pubsetbuf

Reset the internal buffer of this stream to the specified buffer of the specified length. Note that the next write operation will start at the beginning of buffer.

pubsync

Synchronizes the controlled character sequence (the buffers) with the associated character sequence. Operation has no effect, because the stream is always kept in sync (no buffered output). Return 0.

sputc

Write the specified character c to this buffer. Return c, or traits_type::eof() if the end of the write buffer is reached.

sputn

Write the specified length characters at the specified address s 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.

Created with MrDocs