WPILibC++
2019.1.1-beta-2-25-g73de336
|
A raw_ostream that writes to a file descriptor. More...
#include <raw_ostream.h>
Public Member Functions | |
raw_fd_ostream (StringRef Filename, std::error_code &EC, sys::fs::OpenFlags Flags) | |
Open the specified file for writing. More... | |
raw_fd_ostream (int fd, bool shouldClose, bool unbuffered=false) | |
FD is the file descriptor that this writes to. More... | |
void | close () |
Manually flush the stream and close the file. More... | |
bool | supportsSeeking () |
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... | |
![]() | |
raw_pwrite_stream (bool Unbuffered=false) | |
void | pwrite (const char *Ptr, size_t Size, uint64_t Offset) |
![]() | |
raw_ostream (bool unbuffered=false) | |
raw_ostream (const raw_ostream &)=delete | |
void | operator= (const raw_ostream &)=delete |
uint64_t | tell () const |
tell - Return the current offset with the file. | |
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. | |
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<< (ArrayRef< uint8_t > Arr) |
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<< (const std::vector< uint8_t > &Arr) |
raw_ostream & | operator<< (const SmallVectorImpl< uint8_t > &Arr) |
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. | |
raw_ostream & | write_escaped (StringRef Str, bool UseHexEscapes=false) |
Output Str , turning '\', '', '', '"', and anything that doesn't satisfy std::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 & | operator<< (const format_object_base &Fmt) |
raw_ostream & | operator<< (const FormattedString &) |
raw_ostream & | operator<< (const FormattedNumber &) |
raw_ostream & | operator<< (const FormattedBytes &) |
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. More... | |
virtual raw_ostream & | resetColor () |
Resets the colors to terminal defaults. More... | |
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. More... | |
virtual bool | has_colors () const |
This function determines if this stream is displayed and supports colors. | |
Additional Inherited Members | |
![]() | |
enum | Colors { BLACK = 0, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE, SAVEDCOLOR } |
![]() | |
void | SetBuffer (char *BufferStart, size_t Size) |
Use the provided buffer as the raw_ostream buffer. More... | |
const char * | getBufferStart () const |
Return the beginning of the current stream buffer, or 0 if the stream is unbuffered. More... | |
A raw_ostream that writes to a file descriptor.
wpi::raw_fd_ostream::raw_fd_ostream | ( | StringRef | Filename, |
std::error_code & | EC, | ||
sys::fs::OpenFlags | Flags | ||
) |
Open the specified file for writing.
If an error occurs, information about the error is put into EC, and the stream should be immediately destroyed; Flags
allows optional flags to control how the file will be opened.
As a special case, if Filename is "-", then the stream will use STDOUT_FILENO instead of opening a file. Note that it will still consider itself to own the file descriptor. In particular, it will close the file descriptor when it is done (this is necessary to detect output errors).
wpi::raw_fd_ostream::raw_fd_ostream | ( | int | fd, |
bool | shouldClose, | ||
bool | unbuffered = false |
||
) |
FD is the file descriptor that this writes to.
If ShouldClose is true, this closes the file when the stream is destroyed.
|
inline |
Set the flag read by has_error() to false.
If the error flag is set at the time when this raw_ostream's destructor is called, report_fatal_error is called to report the error. Use clear_error() after handling the error to avoid this behavior.
"Errors should never pass silently. Unless explicitly silenced."
void wpi::raw_fd_ostream::close | ( | ) |
Manually flush the stream and close the file.
Note that this does not call fsync.
|
inline |
Return the value of the flag in this raw_fd_ostream indicating whether an output error has been encountered.
This doesn't implicitly flush any pending output. Also, it doesn't guarantee to detect all errors unless the stream has been closed.
uint64_t wpi::raw_fd_ostream::seek | ( | uint64_t | off | ) |
Flushes the stream and repositions the underlying file descriptor position to the offset specified from the beginning of the file.