castor::format::BasicIndentBuffer< char_type, fill_char, traits > Struct Template Reference

Stream buffer used by streams to indent lines. More...

#include <StreamIndentBuffer.hpp>

Inheritance diagram for castor::format::BasicIndentBuffer< char_type, fill_char, traits >:

Collaboration diagram for castor::format::BasicIndentBuffer< char_type, fill_char, traits >:

Public Types
using	int_type = typename traits::int_type
using	pos_type = typename traits::pos_type
using	off_type = typename traits::off_type

Public Member Functions
	BasicIndentBuffer (std::basic_streambuf< char_type, traits > *sbuf)
	Constructor.
int	indent () const
	Retrieves current indentation value.
void	indent (int i)
	Defines the indentation value.
std::streambuf *	sbuf () const
	Retrieves the stream buffer.

Detailed Description

template<typename char_type, char_type fill_char, typename traits>
struct castor::format::BasicIndentBuffer< char_type, fill_char, traits >

Stream buffer used by streams to indent lines.

Member Typedef Documentation

int_type

template<typename char_type , char_type fill_char, typename traits >

using castor::format::BasicIndentBuffer< char_type, fill_char, traits >::int_type = typename traits::int_type

off_type

template<typename char_type , char_type fill_char, typename traits >

using castor::format::BasicIndentBuffer< char_type, fill_char, traits >::off_type = typename traits::off_type

pos_type

template<typename char_type , char_type fill_char, typename traits >

using castor::format::BasicIndentBuffer< char_type, fill_char, traits >::pos_type = typename traits::pos_type

Constructor & Destructor Documentation

BasicIndentBuffer()

template<typename char_type , char_type fill_char, typename traits >

castor::format::BasicIndentBuffer< char_type, fill_char, traits >::BasicIndentBuffer ( std::basic_streambuf< char_type, traits > * sbuf )

inlineexplicit

Constructor.

Member Function Documentation

indent() [1/2]

template<typename char_type , char_type fill_char, typename traits >

int castor::format::BasicIndentBuffer< char_type, fill_char, traits >::indent ( ) const

inline

Retrieves current indentation value.

Returns

The value

indent() [2/2]

template<typename char_type , char_type fill_char, typename traits >

void castor::format::BasicIndentBuffer< char_type, fill_char, traits >::indent ( int i )

inline

Defines the indentation value.

Parameters

[in]

i

The new value

sbuf()

template<typename char_type , char_type fill_char, typename traits >

std::streambuf * castor::format::BasicIndentBuffer< char_type, fill_char, traits >::sbuf ( ) const

inline

Retrieves the stream buffer.

Returns

The buffer

---

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

• CastorUtils/Stream/StreamIndentBuffer.hpp