StreamString Class Reference

Collects text output into a String, splitting on newlines. More...

#include <streamstring.h>

Public Types
using	OnNewLineFunc = std::function< bool(String &)>
	Callback type invoked for each completed line.

Public Member Functions
	StreamString ()
	Constructs a StreamString with no callback.
	StreamString (OnNewLineFunc func)
	Constructs a StreamString with a newline callback.
	StreamString (const StreamString &)=delete
	Deleted copy constructor.
StreamString &	operator= (const StreamString &)=delete
	Deleted copy assignment operator.
	StreamString (StreamString &&)=delete
	Deleted move constructor.
StreamString &	operator= (StreamString &&)=delete
	Deleted move assignment operator.
TextStream &	stream ()
	Returns the TextStream associated with this buffer.
void	setOnNewLine (OnNewLineFunc func)
	Sets or replaces the newline callback.
const String &	line () const
	Returns the current (possibly incomplete) line buffer.
void	clear ()
	Clears the accumulated line buffer.

Detailed Description

Collects text output into a String, splitting on newlines.

StreamString accumulates characters written to it. When a newline or flush is encountered, it invokes the onNewLine callback with the accumulated line. The callback returns true to clear the line buffer, or false to keep accumulating.

Example usage (routing stream output to the logger):

StreamString ss([](String &line) {
        promekiInfo("%s", line.cstr());
        return true;
});
ss.stream() << "Hello " << 42 << promeki::endl;

Constructor & Destructor Documentation

StreamString()

StreamString::StreamString ( OnNewLineFunc  func )

inline

Constructs a StreamString with a newline callback.

Parameters

func	Callback invoked when a complete line is available.

Member Function Documentation

line()

const String & StreamString::line ( ) const

inline

Returns the current (possibly incomplete) line buffer.

Returns

Const reference to the accumulated line.

setOnNewLine()

void StreamString::setOnNewLine ( OnNewLineFunc  func )

inline

Sets or replaces the newline callback.

Parameters

func	New callback to invoke on each complete line.

stream()

TextStream & StreamString::stream ( )

inline

Returns the TextStream associated with this buffer.

Returns

Reference to the text stream.

---

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

• include/promeki/core/streamstring.h