wpi::raw_uv_ostream Class Reference

raw_ostream style output to a SmallVector of uv::Buffer buffers. More...

#include <wpinet/raw_uv_ostream.h>

Inheritance diagram for wpi::raw_uv_ostream:

Public Member Functions
	raw_uv_ostream (SmallVectorImpl< uv::Buffer > &bufs, size_t allocSize)
	Construct a new raw_uv_ostream.
	raw_uv_ostream (SmallVectorImpl< uv::Buffer > &bufs, std::function< uv::Buffer()> alloc)
	Construct a new raw_uv_ostream.
	~raw_uv_ostream () override=default
std::span< uv::Buffer >	bufs ()
	Returns an span to the buffers.
void	flush ()=delete
void	reset ()
	Resets the amount of allocated space.
Public Member Functions inherited from wpi::raw_ostream
	raw_ostream (bool unbuffered=false, OStreamKind K=OStreamKind::OK_OStream)
	raw_ostream (const raw_ostream &)=delete
void	operator= (const raw_ostream &)=delete
virtual	~raw_ostream ()
uint64_t	tell () const
	tell - Return the current offset with the file.
OStreamKind	get_kind () const
virtual void	reserveExtraSpace (uint64_t ExtraSize)
	If possible, pre-allocate ExtraSize bytes for stream data.
void	SetBuffered ()
	Set the stream to be buffered, with an automatically determined buffer size.
void	SetBufferSize (size_t Size)
	Set the stream to be buffered, using the specified buffer size.
size_t	GetBufferSize () const
void	SetUnbuffered ()
	Set the stream to be unbuffered.
size_t	GetNumBytesInBuffer () const
void	flush ()
raw_ostream &	operator<< (char C)
raw_ostream &	operator<< (unsigned char C)
raw_ostream &	operator<< (signed char C)
raw_ostream &	operator<< (std::span< const uint8_t > Arr)
raw_ostream &	operator<< (std::string_view Str)
raw_ostream &	operator<< (const char *Str)
raw_ostream &	operator<< (const std::string &Str)
raw_ostream &	operator<< (const SmallVectorImpl< char > &Str)
raw_ostream &	operator<< (const std::vector< uint8_t > &Arr)
raw_ostream &	operator<< (const SmallVectorImpl< uint8_t > &Arr)
raw_ostream &	write_escaped (std::string_view Str, bool UseHexEscapes=false)
	Output Str, turning '\', '\t', ' ', '"', and anything that doesn't satisfy wpi::isPrint into an escape sequence.
raw_ostream &	write (unsigned char C)
raw_ostream &	write (const char *Ptr, size_t Size)
raw_ostream &	write (const uint8_t *Ptr, size_t Size)
raw_ostream &	indent (unsigned NumSpaces)
	indent - Insert 'NumSpaces' spaces.
raw_ostream &	write_zeros (unsigned NumZeros)
	write_zeros - Insert 'NumZeros' nulls.
virtual raw_ostream &	changeColor (enum Colors Color, bool Bold=false, bool BG=false)
	Changes the foreground color of text that will be output from this point forward.
virtual raw_ostream &	resetColor ()
	Resets the colors to terminal defaults.
virtual raw_ostream &	reverseColor ()
	Reverses the foreground and background colors.
virtual bool	is_displayed () const
	This function determines if this stream is connected to a "tty" or "console" window.
virtual bool	has_colors () const
	This function determines if this stream is displayed and supports colors.
virtual void	enable_colors (bool)
bool	colors_enabled () const

Additional Inherited Members
Public Types inherited from wpi::raw_ostream
enum class	OStreamKind { OK_OStream , OK_FDStream , OK_SVecStream }
enum class	Colors {   BLACK = 0 , RED , GREEN , YELLOW ,   BLUE , MAGENTA , CYAN , WHITE ,   BRIGHT_BLACK , BRIGHT_RED , BRIGHT_GREEN , BRIGHT_YELLOW ,   BRIGHT_BLUE , BRIGHT_MAGENTA , BRIGHT_CYAN , BRIGHT_WHITE ,   SAVEDCOLOR , RESET }
Static Public Attributes inherited from wpi::raw_ostream
static constexpr Colors	BLACK = Colors::BLACK
static constexpr Colors	RED = Colors::RED
static constexpr Colors	GREEN = Colors::GREEN
static constexpr Colors	YELLOW = Colors::YELLOW
static constexpr Colors	BLUE = Colors::BLUE
static constexpr Colors	MAGENTA = Colors::MAGENTA
static constexpr Colors	CYAN = Colors::CYAN
static constexpr Colors	WHITE = Colors::WHITE
static constexpr Colors	BRIGHT_BLACK = Colors::BRIGHT_BLACK
static constexpr Colors	BRIGHT_RED = Colors::BRIGHT_RED
static constexpr Colors	BRIGHT_GREEN = Colors::BRIGHT_GREEN
static constexpr Colors	BRIGHT_YELLOW = Colors::BRIGHT_YELLOW
static constexpr Colors	BRIGHT_BLUE = Colors::BRIGHT_BLUE
static constexpr Colors	BRIGHT_MAGENTA = Colors::BRIGHT_MAGENTA
static constexpr Colors	BRIGHT_CYAN = Colors::BRIGHT_CYAN
static constexpr Colors	BRIGHT_WHITE = Colors::BRIGHT_WHITE
static constexpr Colors	SAVEDCOLOR = Colors::SAVEDCOLOR
static constexpr Colors	RESET = Colors::RESET
Protected Member Functions inherited from wpi::raw_ostream
void	SetBuffer (char *BufferStart, size_t Size)
	Use the provided buffer as the raw_ostream buffer.
void	SetNumBytesInBuffer (size_t Size)
	Force-set the number of bytes in the raw_ostream buffer.
virtual size_t	preferred_buffer_size () const
	Return an efficient buffer size for the underlying output mechanism.
const char *	getBufferStart () const
	Return the beginning of the current stream buffer, or 0 if the stream is unbuffered.

Detailed Description

raw_ostream style output to a SmallVector of uv::Buffer buffers.

Fixed-size buffers are allocated and appended as necessary to fit the data being output. The SmallVector need not be empty at start.

Constructor & Destructor Documentation

raw_uv_ostream() [1/2]

wpi::raw_uv_ostream::raw_uv_ostream ( SmallVectorImpl< uv::Buffer > & bufs, size_t allocSize )

inline

Construct a new raw_uv_ostream.

Parameters

bufs	Buffers vector. NOT cleared on construction.
allocSize	Size to allocate for each buffer; allocation will be performed using Buffer::Allocate().

raw_uv_ostream() [2/2]

wpi::raw_uv_ostream::raw_uv_ostream ( SmallVectorImpl< uv::Buffer > & bufs, std::function< uv::Buffer()> alloc )

inline

Construct a new raw_uv_ostream.

Parameters

bufs	Buffers vector. NOT cleared on construction.
alloc	Allocator.

~raw_uv_ostream()

wpi::raw_uv_ostream::~raw_uv_ostream ( )

overridedefault

Member Function Documentation

bufs()

std::span< uv::Buffer > wpi::raw_uv_ostream::bufs ( )

inline

Returns an span to the buffers.

flush()

void wpi::raw_uv_ostream::flush ( )

delete

reset()

void wpi::raw_uv_ostream::reset ( )

inline

Resets the amount of allocated space.

---

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

• wpinet/raw_uv_ostream.h