ara::log::LogStream Class Reference

A stream pipeline to combine log entities. More...

#include <log_stream.h>

Public Member Functions
void	Flush () noexcept
	Clear the stream.
template<typename T >
LogStream &	operator<< (const Argument< T > &arg)
	Arugment insertion operator. More...
LogStream &	operator<< (const LogStream &value)
	LogStream insertion operator. More...
LogStream &	operator<< (bool value)
	Boolean insertion operator. More...
LogStream &	operator<< (uint8_t value)
	Byte insertion operator. More...
LogStream &	operator<< (uint32_t value)
	Unsigned integer insertion operator. More...
LogStream &	operator<< (float value)
	Float insertion operator. More...
LogStream &	operator<< (const std::string &value)
	String insertion operator. More...
LogStream &	operator<< (const char *value)
	C-syle string insertion operator. More...
LogStream &	operator<< (LogLevel value)
	LogLeve insertion operator. More...
LogStream &	operator<< (const ara::core::ErrorCode &value)
	ErrorCode insertion operator. More...
LogStream &	operator<< (const ara::core::InstanceSpecifier &value) noexcept
	InstanceSpecifier insertion operator. More...
LogStream &	operator<< (std::vector< std::uint8_t > value)
	Data array insertion operator. More...
LogStream &	WithLocation (std::string file, int line)
	Log stream at a certian file and a certian line within the file. More...
std::string	ToString () const noexcept
	Convert the current log stream to a standard string. More...

Detailed Description

A stream pipeline to combine log entities.

Member Function Documentation

operator<<() [1/12]

LogStream & ara::log::LogStream::operator<<

(

bool

value

)

Boolean insertion operator.

Parameters

value

A boolean value

Returns

Reference to the current log stream

operator<<() [2/12]

LogStream & ara::log::LogStream::operator<<

(

const ara::core::ErrorCode &

value

)

ErrorCode insertion operator.

Parameters

value

An error code object

Returns

Reference to the current log stream

operator<<() [3/12]

LogStream & ara::log::LogStream::operator<< ( const ara::core::InstanceSpecifier &  value )

noexcept

InstanceSpecifier insertion operator.

Parameters

value

An instance specifier object

Returns

Reference to the current log stream

operator<<() [4/12]

template<typename T >

LogStream & ara::log::LogStream::operator<< ( const Argument< T > &  arg )

inline

Arugment insertion operator.

Template Parameters

T	Argument playload type

Parameters

arg	An agrgument

Returns

Reference to the current log stream

operator<<() [5/12]

LogStream & ara::log::LogStream::operator<<

(

const char *

value

)

C-syle string insertion operator.

Parameters

value

Character array

Returns

Reference to the current log stream

operator<<() [6/12]

LogStream & ara::log::LogStream::operator<<

(

const LogStream &

value

)

LogStream insertion operator.

Parameters

value

Another logstream

Returns

Reference to the current log stream

operator<<() [7/12]

LogStream & ara::log::LogStream::operator<<

(

const std::string &

value

)

String insertion operator.

Parameters

value

A string

Returns

Reference to the current log stream

operator<<() [8/12]

LogStream & ara::log::LogStream::operator<<

(

float

value

)

Float insertion operator.

Parameters

value

A float value

Returns

Reference to the current log stream

operator<<() [9/12]

LogStream & ara::log::LogStream::operator<<

(

LogLevel

value

)

LogLeve insertion operator.

Parameters

value

Log severity level

Returns

Reference to the current log stream

operator<<() [10/12]

LogStream & ara::log::LogStream::operator<<

(

std::vector< std::uint8_t >

value

)

Data array insertion operator.

Parameters

value

Data byte vector

Returns

Reference to the current log stream

operator<<() [11/12]

LogStream & ara::log::LogStream::operator<<

(

uint32_t

value

)

Unsigned integer insertion operator.

Parameters

value

An unsigned integer value

Returns

Reference to the current log stream

operator<<() [12/12]

LogStream & ara::log::LogStream::operator<<

(

uint8_t

value

)

Byte insertion operator.

Parameters

value

A byte value

Returns

Reference to the current log stream

ToString()

std::string ara::log::LogStream::ToString ( ) const

noexcept

Convert the current log stream to a standard string.

Returns

Serialized log stream string

WithLocation()

LogStream & ara::log::LogStream::WithLocation	(	std::string	file,
		int	line
	)

Log stream at a certian file and a certian line within the file.

Parameters

file	File name
line	Line number

Returns

Reference to the current log stream