A raw_ostream of a file for reading/writing/seeking. More...

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

Inheritance diagram for wpi::raw_fd_stream:

Public Member Functions
	raw_fd_stream (std::string_view Filename, std::error_code &EC)
	Open the specified file for reading/writing/seeking. More...

Public Member Functions inherited from wpi::raw_fd_ostream
	raw_fd_ostream (std::string_view Filename, std::error_code &EC)
	Open the specified file for writing. More...

	raw_fd_ostream (std::string_view Filename, std::error_code &EC, fs::CreationDisposition Disp)

	raw_fd_ostream (std::string_view Filename, std::error_code &EC, fs::FileAccess Access)

	raw_fd_ostream (std::string_view Filename, std::error_code &EC, fs::OpenFlags Flags)

	raw_fd_ostream (std::string_view Filename, std::error_code &EC, fs::CreationDisposition Disp, fs::FileAccess Access, fs::OpenFlags Flags)

	raw_fd_ostream (int fd, bool shouldClose, bool unbuffered=false, OStreamKind K=OStreamKind::OK_OStream)
	FD is the file descriptor that this writes to. More...

	~raw_fd_ostream () override

void	close ()
	Manually flush the stream and close the file. More...

bool	supportsSeeking () const

bool	isRegularFile () const

uint64_t	seek (uint64_t off)
	Flushes the stream and repositions the underlying file descriptor position to the offset specified from the beginning of the file. More...

std::error_code	error () const

bool	has_error () const
	Return the value of the flag in this raw_fd_ostream indicating whether an output error has been encountered. More...

void	clear_error ()
	Set the flag read by has_error() to false. More...

Public Member Functions inherited from wpi::raw_pwrite_stream
	raw_pwrite_stream (bool Unbuffered=false, OStreamKind K=OStreamKind::OK_OStream)

void	pwrite (const char *Ptr, size_t Size, uint64_t Offset)

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

Static Public Member Functions
static bool	classof (const raw_ostream *OS)
	Check if `OS` is a pointer of type raw_fd_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_fd_ostream
void	error_detected (std::error_code EC)
	Set the flag indicating that an output error has been encountered. More...

int	get_fd () const
	Return the file descriptor. More...

void	inc_pos (uint64_t Delta)

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

void	SetNumBytesInBuffer (size_t Size)
	Force-set the number of bytes in 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 of a file for reading/writing/seeking.

Constructor & Destructor Documentation

◆ raw_fd_stream()

wpi::raw_fd_stream::raw_fd_stream	(	std::string_view	Filename,
		std::error_code &	EC
	)

Open the specified file for reading/writing/seeking.

If an error occurs, information about the error is put into EC, and the stream should be immediately destroyed.

Member Function Documentation

◆ classof()

static bool wpi::raw_fd_stream::classof ( const raw_ostream * OS )

static

Check if OS is a pointer of type raw_fd_stream*.

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ raw_fd_stream()

Member Function Documentation

◆ classof()