A raw_ostream that writes to an std::string. More...

#include </home/runner/work/allwpilib/allwpilib/wpiutil/src/main/native/thirdparty/llvm/include/wpi/raw_ostream.h>

Inheritance diagram for wpi::raw_string_ostream:

Public Member Functions
	raw_string_ostream (std::string &O)

std::string &	str ()
	Returns the string's reference. More...

void	reserveExtraSpace (uint64_t ExtraSize) override
	If possible, pre-allocate `ExtraSize` bytes for stream data. 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

A raw_ostream that writes to an std::string.

This is a simple adaptor class. This class does not encounter output errors. raw_string_ostream operates without a buffer, delegating all memory management to the std::string. Thus the std::string is always up-to-date, may be used directly and there is no need to call flush().

Constructor & Destructor Documentation

◆ raw_string_ostream()

wpi::raw_string_ostream::raw_string_ostream ( std::string & O )

inlineexplicit

Member Function Documentation

◆ reserveExtraSpace()

void wpi::raw_string_ostream::reserveExtraSpace ( uint64_t ExtraSize )

inlineoverridevirtual

If possible, pre-allocate ExtraSize bytes for stream data.

i.e. it extends internal buffers to keep additional ExtraSize bytes. So that the stream could keep at least tell() + ExtraSize bytes without re-allocations. reserveExtraSpace() does not change the size/data of the stream.

Reimplemented from wpi::raw_ostream.

◆ str()

std::string & wpi::raw_string_ostream::str ( )

inline

Returns the string's reference.

In most cases it is better to simply use the underlying std::string directly. TODO: Consider removing this API.

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

/home/runner/work/allwpilib/allwpilib/wpiutil/src/main/native/thirdparty/llvm/include/wpi/raw_ostream.h