terse::CharOutputStreamBuf< TStream, BufferSize > Class Template Reference

#include <CharOutputStreamBuf.h>

Inheritance diagram for terse::CharOutputStreamBuf< TStream, BufferSize >:

Collaboration diagram for terse::CharOutputStreamBuf< TStream, BufferSize >:

Public Types
using	PosType = std::streambuf::pos_type
using	OffType = std::streambuf::off_type
using	CharType = std::streambuf::char_type
using	IntType = std::streambuf::int_type
using	TraitsType = std::streambuf::traits_type

Public Member Functions
	CharOutputStreamBuf (TStream *stream_)
	~CharOutputStreamBuf ()
std::streamsize	xsputn (const CharType *source, std::streamsize size) override
IntType	overflow (IntType value) override
IntType	sync () override

Private Attributes
TStream *	stream
std::array< char, BufferSize >	buffer

Member Typedef Documentation

CharType

template<class TStream , std::size_t BufferSize = 4096ul>

using terse::CharOutputStreamBuf< TStream, BufferSize >::CharType = std::streambuf::char_type

IntType

template<class TStream , std::size_t BufferSize = 4096ul>

using terse::CharOutputStreamBuf< TStream, BufferSize >::IntType = std::streambuf::int_type

OffType

template<class TStream , std::size_t BufferSize = 4096ul>

using terse::CharOutputStreamBuf< TStream, BufferSize >::OffType = std::streambuf::off_type

PosType

template<class TStream , std::size_t BufferSize = 4096ul>

using terse::CharOutputStreamBuf< TStream, BufferSize >::PosType = std::streambuf::pos_type

TraitsType

template<class TStream , std::size_t BufferSize = 4096ul>

using terse::CharOutputStreamBuf< TStream, BufferSize >::TraitsType = std::streambuf::traits_type

Constructor & Destructor Documentation

CharOutputStreamBuf()

template<class TStream , std::size_t BufferSize = 4096ul>

terse::CharOutputStreamBuf< TStream, BufferSize >::CharOutputStreamBuf ( TStream *  stream_ )

inlineexplicit

                                                       : stream{stream_}, buffer{} {
            setp(buffer.data(), buffer.data() + buffer.size() - 1ul);
        }

References terse::CharOutputStreamBuf< TStream, BufferSize >::buffer.

~CharOutputStreamBuf()

template<class TStream , std::size_t BufferSize = 4096ul>

terse::CharOutputStreamBuf< TStream, BufferSize >::~CharOutputStreamBuf ( )

inline

                               {
            sync();
        }

References terse::CharOutputStreamBuf< TStream, BufferSize >::sync().

Member Function Documentation

overflow()

template<class TStream , std::size_t BufferSize = 4096ul>

IntType terse::CharOutputStreamBuf< TStream, BufferSize >::overflow ( IntType  value )

inlineoverride

                                                 {
            // Write a single character
            if (value == TraitsType::eof()) {
                return value;
            }
 
            const CharType data = static_cast<CharType>(value);
            *pptr() = data;
            pbump(1);
            return (sync() ? TraitsType::eof() : value);
        }

References terse::CharOutputStreamBuf< TStream, BufferSize >::sync().

sync()

template<class TStream , std::size_t BufferSize = 4096ul>

IntType terse::CharOutputStreamBuf< TStream, BufferSize >::sync ( )

inlineoverride

                                {
            const std::ptrdiff_t diff = pptr() - pbase();
            if (diff > 0) {
                const std::size_t bytesToWrite = static_cast<std::size_t>(diff);
                const std::size_t bytesWritten = stream->write(buffer.data(), bytesToWrite);
                pbump(static_cast<IntType>(-diff));
                return (bytesToWrite == bytesWritten ? 0 : -1);
            }
            return 0;
        }

References terse::CharOutputStreamBuf< TStream, BufferSize >::buffer, and terse::CharOutputStreamBuf< TStream, BufferSize >::stream.

Referenced by terse::CharOutputStreamBuf< TStream, BufferSize >::overflow(), terse::CharOutputStreamBuf< TStream, BufferSize >::xsputn(), and terse::CharOutputStreamBuf< TStream, BufferSize >::~CharOutputStreamBuf().

xsputn()

template<class TStream , std::size_t BufferSize = 4096ul>

std::streamsize terse::CharOutputStreamBuf< TStream, BufferSize >::xsputn ( const CharType *  source, std::streamsize  size  )

inlineoverride

                                                                                  {
            // Write a sequence of characters
            if (size <= 0) {
                return 0;
            }
 
            // If there's space, write data into buffer
            const std::ptrdiff_t spaceLeft = epptr() - pptr();
            if (size < spaceLeft) {
                std::memcpy(pptr(), source, static_cast<std::size_t>(size));
                pbump(static_cast<IntType>(size));
                return size;
            }
 
            // No space in buffer, flush it first, and write directly into stream
            if (sync()) {
                return 0;
            }
            return static_cast<std::streamsize>(stream->write(source, static_cast<std::size_t>(size)));
        }

References terse::CharOutputStreamBuf< TStream, BufferSize >::stream, and terse::CharOutputStreamBuf< TStream, BufferSize >::sync().

Member Data Documentation

buffer

template<class TStream , std::size_t BufferSize = 4096ul>

std::array<char, BufferSize> terse::CharOutputStreamBuf< TStream, BufferSize >::buffer

private

Referenced by terse::CharOutputStreamBuf< TStream, BufferSize >::CharOutputStreamBuf(), and terse::CharOutputStreamBuf< TStream, BufferSize >::sync().

stream

template<class TStream , std::size_t BufferSize = 4096ul>

TStream* terse::CharOutputStreamBuf< TStream, BufferSize >::stream

private

Referenced by terse::CharOutputStreamBuf< TStream, BufferSize >::sync(), and terse::CharOutputStreamBuf< TStream, BufferSize >::xsputn().

---

The documentation for this class was generated from the following file:

• CharOutputStreamBuf.h