xtd 0.2.0
Loading...
Searching...
No Matches
xtd::io::synchronized_text_reader Class Reference
Inheritance diagram for xtd::io::synchronized_text_reader:
xtd::io::text_reader xtd::object

Definition

Represents a synchronized text reader.

class core_export_ synchronized_text_reader : public xtd::io::text_reader
Represents a reader that can read a sequential series of characters.
Definition text_reader.hpp:38
#define core_export_
Define shared library export.
Definition core_export.hpp:13
Inheritance
xtd::io::text_readerxtd::io::synchronized_text_reader
Namespace
xtd::io
Library
xtd.core

Public Methods

auto read () -> xtd::int32 override
 Reads the next character from the input stream and advances the character position by one character.
 

Additional Inherited Members

virtual auto close () -> void
 Closes the xtd::io::text_reader and releases any system resources associated with the text_reader.
 
virtual auto peek () const -> xtd::int32
 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.
 
virtual auto read (xtd::span< char > &buffer) -> xtd::size
 Reads the characters from the current reader and writes the data to the specified buffer.
 
virtual auto read (xtd::array< char > &buffer, xtd::size index, xtd::size count) -> xtd::size
 Reads a specified maximum number of characters from the current text reader and writes the data to a buffer, beginning at the specified index.
 
virtual auto read_block (xtd::span< char > &buffer) -> xtd::size
 Reads the characters from the current stream and writes the data to a buffer.
 
virtual auto read_block (xtd::array< char > &buffer, xtd::size index, xtd::size count) -> xtd::size
 Reads a specified maximum number of characters from the current text reader and writes the data to a buffer, beginning at the specified index.
 
virtual auto read_line () -> xtd::string
 Reads a line of characters from the current stream and returns the data as a string.
 
virtual auto read_to_end () -> xtd::string
 Reads all characters from the current position to the end of the text_reader and returns them as one string.
 
 object ()=default
 Create a new instance of the ultimate base class object.
 
virtual bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object.
 
virtual xtd::size get_hash_code () const noexcept
 Serves as a hash function for a particular type.
 
virtual type_object get_type () const noexcept
 Gets the type of the current instance.
 
template<class object_t>
xtd::unique_ptr_object< object_t > memberwise_clone () const
 Creates a shallow copy of the current object.
 
virtual xtd::string to_string () const
 Returns a xtd::string that represents the current object.
 
static null_text_readernull () noexcept
 Provides a text_reader with no data to read from.
 
static auto synchronised (text_reader &reader) noexcept -> synchronized_text_reader
 Creates a thread-safe (synchronized) wrapper around the specified text_reader object.
 
template<class object_a_t, class object_b_t>
static bool equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
 Determines whether the specified object instances are considered equal.
 
template<class object_a_t, class object_b_t>
static bool reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
 Determines whether the specified object instances are the same instance.
 
 text_reader ()=default
 Initializes a new instance of the xtd::io::text_reader class.
 

Member Function Documentation

◆ read()

auto xtd::io::synchronized_text_reader::read ( ) -> xtd::int32
nodiscardoverridevirtual

Reads the next character from the input stream and advances the character position by one character.

Returns
The next character from the input stream, or EOF if no more characters are available.

Reimplemented from xtd::io::text_reader.


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