LOG4SHIB::CATEGORYSTREAM(3)

πŸ“¦ version 2.0.1, in opensuse-leap 16.0

πŸ’… NAME πŸ’…

okay bestie, this is the log4shib::CategoryStream(3) page from the log4shib Library Functions Manual, and the whole mood is: log4shib::CategoryStream β€” this class enables streaming simple types and objects to a category πŸ’–


✨ SYNOPSIS ✨

#include <CategoryStream.hh>

πŸŽ€ Public Types πŸŽ€

  • typedef CategoryStream &(* cspf) (CategoryStream &) β€” the cspf typedef, exactly as written, no cap 🫢

🫢 Public Member Functions 🫢

  • CategoryStream (Category &category, Priority::Value priority) β€” Construct a CategoryStream for given Category with given priority.
  • ~CategoryStream () β€” Destructor for CategoryStream.
  • Category & getCategory () const β€” Returns the destination Category for this stream.
  • Priority::Value getPriority () const throw () β€” Returns the priority for this stream.
  • void flush () β€” Flush the contents of the stream buffer to the Category and empties the buffer.
  • template<typename T> CategoryStream & operator<< (const T &t) β€” Stream in arbitrary types and objects.
  • CategoryStream & operator<< (cspf) β€” this overload is listed in the original with just its signature, so I’m not inventing extra lore πŸ’…

🌸 Friends 🌸

  • LOG4SHIB_EXPORT friend CategoryStream & eol (CategoryStream &os) β€” eol manipulator πŸ¦‹

πŸ¦‹ Detailed Description πŸ¦‹

This class enables streaming simple types and objects to a category.

Use category.errorStream(), etc. to obtain a CategoryStream class. iykyk ✨


πŸ’– Member Typedef Documentation πŸ’–

typedef CategoryStream &(* log4shib::CategoryStream::cspf) (CategoryStream &)

πŸŽ€ Constructor & Destructor Documentation πŸŽ€

log4shib::CategoryStream::CategoryStream (Category & category, Priority::Value priority)

Construct a CategoryStream for given Category with given priority.

Parameters

  • category β€” The category this stream will send log messages to.
  • priority β€” The priority the log messages will get or Priority::NOTSET to silently discard any streamed in messages.

log4shib::CategoryStream::~CategoryStream ()

Destructor for CategoryStream.


🌈 Member Function Documentation 🌈

void log4shib::CategoryStream::flush ()

Flush the contents of the stream buffer to the Category and empties the buffer. clean and satisfying, fr fr 🧚

Category & log4shib::CategoryStream::getCategory () const [inline]

Returns the destination Category for this stream.

Returns

  • The Category.

Priority::Value log4shib::CategoryStream::getPriority () const [inline]

Returns the priority for this stream.

Returns

  • The priority.

template<typename T> CategoryStream & log4shib::CategoryStream::operator<< (const T & t) [inline]

Stream in arbitrary types and objects.

Parameters

  • t β€” The value or object to stream in.

Returns

  • A reference to itself.

CategoryStream & log4shib::CategoryStream::operator<< (cspf pf)

this one is listed with just the signature and no extra description in the original, bestie πŸ’€βœ¨


LOG4SHIB_EXPORT friend CategoryStream & eol (CategoryStream & os) [friend]

eol manipulator


🌟 Author 🌟

Generated automatically by Doxygen for log4shib from the source code.


okay that’s the whole page, bestie 🫢 the footer tea is: source/version log4shib Version 2.0.1, page log4shib::CategoryStream(3) β€” and the original footer shows no separate date, so I’m not making one up πŸ’€βœ¨ periodt