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. More...

	raw_uv_ostream (SmallVectorImpl< uv::Buffer > &bufs, std::function< uv::Buffer()> alloc)
	Construct a new raw_uv_ostream. More...

	~raw_uv_ostream () override=default

std::span< uv::Buffer >	bufs ()
	Returns an span to the buffers. More...

void	flush ()=delete

void	reset ()
	Resets the amount of allocated space. More...

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. More...

OStreamKind	get_kind () const

virtual void	reserveExtraSpace (uint64_t ExtraSize)
	If possible, pre-allocate `ExtraSize` bytes for stream data. More...

void	SetBuffered ()
	Set the stream to be buffered, with an automatically determined buffer size. More...

void	SetBufferSize (size_t Size)
	Set the stream to be buffered, using the specified buffer size. More...

size_t	GetBufferSize () const

void	SetUnbuffered ()
	Set the stream to be unbuffered. More...

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. More...

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. More...

raw_ostream &	write_zeros (unsigned NumZeros)
	write_zeros - Insert 'NumZeros' nulls. More...

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. More...

virtual raw_ostream &	resetColor ()
	Resets the colors to terminal defaults. More...

virtual raw_ostream &	reverseColor ()
	Reverses the foreground and background colors. More...

virtual bool	is_displayed () const
	This function determines if this stream is connected to a "tty" or "console" window. More...

virtual bool	has_colors () const
	This function determines if this stream is displayed and supports colors. More...

virtual void	enable_colors (bool)

bool	colors_enabled () const

void	tie (raw_ostream *TieTo)
	Tie this stream to the specified stream. More...

Additional Inherited Members
Public Types inherited from wpi::raw_ostream
enum class	OStreamKind { OK_OStream , OK_FDStream }

enum class	Colors { BLACK = 0 , RED , GREEN , YELLOW , BLUE , MAGENTA , CYAN , 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	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. More...

virtual size_t	preferred_buffer_size () const
	Return an efficient buffer size for the underlying output mechanism. More...

const char *	getBufferStart () const
	Return the beginning of the current stream buffer, or 0 if the stream is unbuffered. More...

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ raw_uv_ostream() [1/2]

◆ raw_uv_ostream() [2/2]

◆ ~raw_uv_ostream()

Member Function Documentation

◆ bufs()

◆ flush()

◆ reset()