Represents a reader that can read a sequential series of characters.
- Inheritance
- xtd::object → xtd::io::text_reader
- Header
#include <xtd/io/text_reader>
- Namespace
- xtd::io
- Library
- xtd.core
|
| static synchronized_text_reader | synchronised (text_reader &reader) noexcept |
| | Creates a thread-safe (synchronized) wrapper around the specified text_reader object. More...
|
| |
| virtual void | close () |
| | Closes the xtd::io::text_reader and releases any system resources associated with the text_reader. More...
|
| |
| virtual int32 | peek () const |
| | Reads the next character without changing the state of the reader or the character source. Returns the next available character without actually reading it from the input stream. More...
|
| |
| virtual int32 | read () |
| | Reads the next character from the input stream and advances the character position by one character. More...
|
| |
| virtual size_t | read (std::vector< char > &buffer, size_t index, size_t count) |
| | Reads a specified maximum number of characters from the current text reader and writes the data to a buffer, beginning at the specified index. More...
|
| |
| virtual size_t | read_block (std::vector< char > &buffer, size_t index, size_t count) |
| | Reads a specified maximum number of characters from the current text reader and writes the data to a buffer, beginning at the specified index. More...
|
| |
| virtual xtd::ustring | read_line () |
| | Reads a line of characters from the current stream and returns the data as a string. More...
|
| |
| virtual xtd::ustring | read_to_end () |
| | Reads all characters from the current position to the end of the text_reader and returns them as one string. More...
|
| |
|
| | object ()=default |
| | Create a new instance of the ultimate base class object. More...
|
| |
| bool | equals (const object &obj) const noexcept |
| | Determines whether the specified object is equal to the current object. More...
|
| |
| virtual size_t | get_hash_code () const noexcept |
| | Serves as a hash function for a particular type. More...
|
| |
| virtual type_object | get_type () const noexcept |
| | Gets the type of the current instance. More...
|
| |
| template<typename object_t > |
| std::unique_ptr< object_t > | memberwise_clone () const noexcept |
| | Creates a shallow copy of the current object. More...
|
| |
| virtual xtd::ustring | to_string () const noexcept |
| | Returns a sxd::ustring that represents the current object. More...
|
| |
| static bool | equals (const object &object_a, const object &object_b) noexcept |
| | Determines whether the specified object instances are considered equal. More...
|
| |
| static bool | reference_equals (const object &object_a, const object &object_b) noexcept |
| | Determines whether the specified object instances are the same instance. More...
|
| |
◆ text_reader()
| xtd::io::text_reader::text_reader |
( |
| ) |
|
|
protecteddefault |
◆ close()
| virtual void xtd::io::text_reader::close |
( |
| ) |
|
|
virtual |
◆ null()
◆ peek()
| virtual int32 xtd::io::text_reader::peek |
( |
| ) |
const |
|
virtual |
Reads the next character without changing the state of the reader or the character source. Returns the next available character without actually reading it from the input stream.
- Returns
- An integer representing the next character to be read, or EOF if no more characters are available or the stream does not support seeking.
Reimplemented in xtd::io::stream_reader, and xtd::io::string_reader.
◆ read() [1/2]
| virtual int32 xtd::io::text_reader::read |
( |
| ) |
|
|
virtual |
◆ read() [2/2]
| virtual size_t xtd::io::text_reader::read |
( |
std::vector< char > & |
buffer, |
|
|
size_t |
index, |
|
|
size_t |
count |
|
) |
| |
|
virtual |
Reads a specified maximum number of characters from the current text reader and writes the data to a buffer, beginning at the specified index.
- Parameters
-
| buffer | When this method returns, this parameter contains the specified character array with the values between index and (index + count -1) replaced by the characters read from the current source. |
| index | The position in buffer at which to begin writing. |
| count | The maximum number of characters to read. |
- Returns
- The number of characters that have been read. The number will be less than or equal to count, depending on whether all input characters have been read.
◆ read_block()
| virtual size_t xtd::io::text_reader::read_block |
( |
std::vector< char > & |
buffer, |
|
|
size_t |
index, |
|
|
size_t |
count |
|
) |
| |
|
virtual |
Reads a specified maximum number of characters from the current text reader and writes the data to a buffer, beginning at the specified index.
- Parameters
-
| buffer | When this method returns, this parameter contains the specified character array with the values between index and (index + count -1) replaced by the characters read from the current source. |
| index | The position in buffer at which to begin writing. |
| count | The maximum number of characters to read. |
- Returns
- The number of characters that have been read. The number will be less than or equal to count, depending on whether all input characters have been read.
◆ read_line()
Reads a line of characters from the current stream and returns the data as a string.
- Returns
- The next line from the input stream, or the empty string if all characters have been read.
- Examples:
- test_forms.cpp.
◆ read_to_end()
Reads all characters from the current position to the end of the text_reader and returns them as one string.
- Returns
- A string containing all characters from the current position to the end of the text_reader.
- Exceptions
-
◆ synchronised()
The documentation for this class was generated from the following file:
Public Member Functions inherited from xtd::object