bdlb::OptionalPrinter< TYPE > Class Template Reference

#include <bdlb_optionalprinter.h>

Detailed Description

template<class TYPE>
class bdlb::OptionalPrinter< TYPE >

Utility for printing bsl::optional to standard output streams. This class has operator<< defined for it, so it can be used, for example, in ball logs.

See bdlb_optionalprinter

Public Member Functions
	BSLMF_NESTED_TRAIT_DECLARATION (OptionalPrinter, bslfmt::EnableStreamedFormatter)
	OptionalPrinter (const bsl::optional< TYPE > *data)
bsl::ostream &	print (bsl::ostream &stream, int level=0, int spacesPerLevel=4) const

Constructor & Destructor Documentation

OptionalPrinter()

template<class TYPE >

bdlb::OptionalPrinter< TYPE >::OptionalPrinter ( const bsl::optional< TYPE > *  data )

explicit

Create OptionalPrinter with the specified data.

Member Function Documentation

BSLMF_NESTED_TRAIT_DECLARATION()

template<class TYPE >

bdlb::OptionalPrinter< TYPE >::BSLMF_NESTED_TRAIT_DECLARATION	(	OptionalPrinter< TYPE >	,
		bslfmt::EnableStreamedFormatter
	)

print()

template<class TYPE >

bsl::ostream & bdlb::OptionalPrinter< TYPE >::print	(	bsl::ostream &	stream,
		int	level = 0,
		int	spacesPerLevel = 4
	)		const

Format this object to the specified output stream at the (absolute value of) the optionally specified indentation level and return a reference to stream. If level is specified, optionally specify spacesPerLevel, the number of spaces per indentation level for this and all of its nested objects. If level is negative, suppress indentation of the first line. If spacesPerLevel is negative, format the entire output on one line, suppressing all but the initial indentation (as governed by level). If stream is not valid on entry, this operation has no effect.

---

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

• bdlb_optionalprinter.h