streams::null_ostream Class Reference

Implements an empty formatted output that does nothing. More...

#include <fastarduino/empty_streams.h>

Detailed Description

Implements an empty formatted output that does nothing.

It can be used everywhere a streams::ostream is expected but produces no code at all. The following example shows how to add traces that can be disabled at compile time by defining a specific macro:

// Include the right header
#ifdef NO_TRACE
#include <fastarduino/empty_streams.h>
#else
#include <fastarduino/streams.h>
#endif
//...
// Instantiate the right output
#ifdef NO_TRACE
streams::null_ostream trace;
#else
// We use UART for tracing
static char output_buffer[64];
serial::hard::UATX<board::USART::USART0> uatx{output_buffer};
auto trace = uatx.out();
#endif
//...
// Directly use trace anywhere, this won't generate any code if `NO_TRACE`
// was defined at compile time
void f(int value)
{
    //... do something
    trace << F("DEBUG") << value << streams::endl;
    //... do something else
}

Definition at line 69 of file empty_streams.h.

---

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

• fastarduino/empty_streams.h