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

#include "llvm/Support/raw_ostream.h"

Inheritance diagram for llvm::raw_string_ostream:

Collaboration diagram for llvm::raw_string_ostream:

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

	~raw_string_ostream () override

std::string &	str ()
	Flushes the stream contents to the target string and 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 llvm::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

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<< (StringRef Str)

raw_ostream &	operator<< (const char *Str)

raw_ostream &	operator<< (const std::string &Str)

raw_ostream &	operator<< (const SmallVectorImpl< char > &Str)

raw_ostream &	operator<< (unsigned long N)

raw_ostream &	operator<< (long N)

raw_ostream &	operator<< (unsigned long long N)

raw_ostream &	operator<< (long long N)

raw_ostream &	operator<< (const void *P)

raw_ostream &	operator<< (unsigned int N)

raw_ostream &	operator<< (int N)

raw_ostream &	operator<< (double N)

raw_ostream &	write_hex (unsigned long long N)
	Output `N` in hexadecimal, without any prefix or padding. More...

raw_ostream &	operator<< (Colors C)

raw_ostream &	write_uuid (const uuid_t UUID)

raw_ostream &	write_escaped (StringRef Str, bool UseHexEscapes=false)
	Output `Str`, turning '\', '\t', ' ', '"', and anything that doesn't satisfy llvm::isPrint into an escape sequence. More...

raw_ostream &	write (unsigned char C)

raw_ostream &	write (const char *Ptr, size_t Size)

raw_ostream &	operator<< (const format_object_base &Fmt)

raw_ostream &	operator<< (const FormattedString &)

raw_ostream &	operator<< (const FormattedNumber &)

raw_ostream &	operator<< (const formatv_object_base &)

raw_ostream &	operator<< (const FormattedBytes &)

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 enable)

bool	colors_enabled () const

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

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

enum	Colors { Colors::BLACK = 0, Colors::RED, Colors::GREEN, Colors::YELLOW, Colors::BLUE, Colors::MAGENTA, Colors::CYAN, Colors::WHITE, Colors::SAVEDCOLOR, Colors::RESET }

using	uuid_t = uint8_t[16]
	Output a formatted UUID with dash separators. More...

Static Public Attributes inherited from llvm::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 llvm::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.

Definition at line 625 of file raw_ostream.h.

Constructor & Destructor Documentation

◆ raw_string_ostream()

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

inlineexplicit

Definition at line 636 of file raw_ostream.h.

References llvm::raw_ostream::SetUnbuffered().

◆ ~raw_string_ostream()

raw_string_ostream::~raw_string_ostream ( )

override

Definition at line 939 of file raw_ostream.cpp.

References llvm::raw_ostream::flush().

Member Function Documentation

◆ reserveExtraSpace()

void llvm::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 llvm::raw_ostream.

Definition at line 648 of file raw_ostream.h.

References llvm::raw_ostream::tell().