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

Definition

Implements a xtd::io::text_reader that reads characters from a byte stream.

Implements a xtd::io::text_reader that reads characters from a byte stream.
Definition stream_reader.h:28
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::stream_reader
Header
#include <xtd/io/stream_reader>
Namespace
xtd::io
Library
xtd.core
Examples
file_info_move_to.cpp, file_info_open.cpp, file_info_open_read.cpp, file_info_open_write.cpp, generic_ienumerable.cpp, network_stream.cpp, process_with_standard_output_redirection.cpp, tcp_client_ip_v4.cpp, tcp_client_ip_v6.cpp, and test_forms.cpp.

Public Constructors

 stream_reader (const xtd::string &path)
 Initializes a new instance of the stream_reader class for the specified file name.
 
 stream_reader (std::istream &stream)
 Initializes a new instance of the stream_reader class for the specified stream.
 

Public Properties

std::optional< std::reference_wrapper< std::istream > > base_stream () const
 Returns the underlying stream.
 
bool end_of_stream () const
 Gets a value that indicates whether the current stream position is at the end of the stream.
 

Public Methods

void close () override
 Closes the stream_reader object and the underlying stream, and releases any system resources associated with the reader.
 
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 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

◆ stream_reader() [1/2]

xtd::io::stream_reader::stream_reader ( const xtd::string path)
explicit

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

Parameters
pathThe complete file path to be read.
Exceptions
xtd::argument_exceptionpath is a zero-length string, contains only white space, or contains one or more invalid characters as defined by xtd::io::path::invalid_path_chars.

◆ stream_reader() [2/2]

xtd::io::stream_reader::stream_reader ( std::istream &  stream)
explicit

Initializes a new instance of the stream_reader class for the specified stream.

Parameters
streamThe stream to be read.

Member Function Documentation

◆ base_stream()

std::optional< std::reference_wrapper< std::istream > > xtd::io::stream_reader::base_stream ( ) const

Returns the underlying stream.

Returns
The underlying stream.
Examples
generic_ienumerable.cpp.

◆ end_of_stream()

bool xtd::io::stream_reader::end_of_stream ( ) const

Gets a value that indicates whether the current stream position is at the end of the stream.

Returns
true if the current stream position is at the end of the stream; otherwise false.
Examples
file_info_move_to.cpp, generic_ienumerable.cpp, and test_forms.cpp.

◆ close()

void xtd::io::stream_reader::close ( )
overridevirtual

Closes the stream_reader object and the underlying stream, and releases any system resources associated with the reader.

Reimplemented from xtd::io::text_reader.

Examples
generic_ienumerable.cpp.

◆ peek()

int32 xtd::io::stream_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::stream_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: