Helper class to redirect std::ostream to a functor. More...

#include <ostream_redirect.hh>

Inheritance diagram for Dune::Copasi::OStreamRedirect:

Public Member Functions
	~OStreamRedirect () override

	OStreamRedirect (const OStreamRedirect &other)=delete

OStreamRedirect &	operator= (const OStreamRedirect &other)=delete

	OStreamRedirect (OStreamRedirect &&other) noexcept=delete

OStreamRedirect &	operator= (OStreamRedirect &&other) noexcept=delete

Static Public Member Functions
static std::unique_ptr< OStreamRedirect >	make (std::ostream &ostream, fu2::unique_function< void(std::string_view)> redirection, bool line_buffered=true)
	RAII safe constructor of the redirection object While the object is alive, the output of ostream will be redirected to the redirection functor. More...

Detailed Description

Helper class to redirect std::ostream to a functor.

This object takes an std::ostream and redirects its input to a stream buffer owned by this class. When the stream syncs, it forwards the resulting strings views to a functor. It has the effect to redirect the output stream to the functor.

This std::ostream does not directly output data, but forwards any input to its associated functor. It can operate in two different modes:

In line-buffered mode, the buffer will only output complete lines that have been terminated by a newline character. In particular, this mode will ignore any explicit flushing of the C++ stream. This mode is capable of exactly reproducing the original output layout as designed by the user of the std::ostream, but messages may appear later than expected when the user explicitly flushes the C++ stream.
In unbuffered mode, the buffer will always forward all pending data every time the C++ stream is flushed. As most logging sinks are line-oriented and insert an additional newline after each log message, this will not correctly reproduce the original layout of the output. As a lot of people use std::endl instead of just "\n" for ending their lines, this mode will not forward empty lines to the logging system to avoid empty lines after every regular line printed to the C++ stream.

Author: Steffen Müthing

Copyright: BSD-2-Clause

Constructor & Destructor Documentation

◆ ~OStreamRedirect()

Dune::Copasi::OStreamRedirect::~OStreamRedirect ( )

override

◆ OStreamRedirect() [1/2]

Dune::Copasi::OStreamRedirect::OStreamRedirect ( const OStreamRedirect & other )

delete

◆ OStreamRedirect() [2/2]

Dune::Copasi::OStreamRedirect::OStreamRedirect ( OStreamRedirect && other )

deletenoexcept

Member Function Documentation

◆ make()

static std::unique_ptr< OStreamRedirect > Dune::Copasi::OStreamRedirect::make	(	std::ostream &	ostream,
		fu2::unique_function< void(std::string_view)>	redirection,
		bool	line_buffered = `true`
	)

static

RAII safe constructor of the redirection object While the object is alive, the output of ostream will be redirected to the redirection functor.

Parameters

ostream	The output stream to redirect
redirection	The functor to redirect the stream of characters
line_buffered	Whether to operate on buffered mode

Returns: RAII safe pointer to a redirection object

◆ operator=() [1/2]

OStreamRedirect & Dune::Copasi::OStreamRedirect::operator= ( const OStreamRedirect & other )

delete

◆ operator=() [2/2]

OStreamRedirect & Dune::Copasi::OStreamRedirect::operator= ( OStreamRedirect && other )