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

Definition

Implements a xtd::io::text_reader that reads from a string.

Implements a xtd::io::text_reader that reads from a string.
Definition string_reader.h:27
Represents a reader that can read a sequential series of characters.
Definition text_reader.h:36
#define core_export_
Define shared library export.
Definition core_export.h:13
Inheritance
xtd::io::text_readerxtd::io::string_reader
Header
#include <xtd/io/string_reader>
Namespace
xtd::io
Library
xtd.core

Public Constructors

 string_reader (const xtd::string &input)
 Initializes a new instance of the stream_reader class for the specified file name.
 

Public Methods

int32 peek () const override
 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.
 
int32 read () override
 Reads the next character from the input stream and advances the character position by one character.
 

Additional Inherited Members

- Public Member Functions inherited from xtd::io::text_reader
virtual void close ()
 Closes the xtd::io::text_reader and releases any system resources associated with the text_reader.
 
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.
 
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.
 
virtual xtd::string read_line ()
 Reads a line of characters from the current stream and returns the data as a string.
 
virtual xtd::string read_to_end ()
 Reads all characters from the current position to the end of the text_reader and returns them as one string.
 
- Public Member Functions inherited from xtd::object
 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 size_t 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<typename object_t >
xtd::uptr< object_t > memberwise_clone () const
 Creates a shallow copy of the current object.
 
virtual xtd::string to_string () const noexcept
 Returns a xtd::string that represents the current object.
 
- Static Public Member Functions inherited from xtd::io::text_reader
static null_text_readernull () noexcept
 Provides a text_reader with no data to read from.
 
static synchronized_text_reader synchronised (text_reader &reader) noexcept
 Creates a thread-safe (synchronized) wrapper around the specified text_reader object.
 
- Static Public Member Functions inherited from xtd::object
template<typename object_a_t , typename 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<typename object_a_t , typename 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.
 
- Protected Member Functions inherited from xtd::io::text_reader
 text_reader ()=default
 Initializes a new instance of the xtd::io::text_reader class.
 

Constructor & Destructor Documentation

◆ string_reader()

xtd::io::string_reader::string_reader ( const xtd::string input)
explicit

Initializes a new instance of the stream_reader class for the specified file name.

Parameters
pathThe complete file path to be read.

Member Function Documentation

◆ peek()

int32 xtd::io::string_reader::peek ( ) const
overridevirtual

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 from xtd::io::text_reader.

◆ read()

int32 xtd::io::string_reader::read ( )
overridevirtual

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: