System::IO::StreamReader Class Reference

Inherits System::IO::TextReader.

Public Member Functions

 StreamReader (const SharedPtr< Stream > &stream)
 
 StreamReader (const SharedPtr< Stream > &stream, bool detectEncodingFromByteOrderMarks)
 
 StreamReader (const SharedPtr< Stream > &stream, const EncodingPtr &encoding)
 
 StreamReader (const SharedPtr< Stream > &stream, const EncodingPtr &encoding, bool detectEncodingFromByteOrderMarks)
 
 StreamReader (const SharedPtr< Stream > &stream, const EncodingPtr &encoding, bool detectEncodingFromByteOrderMarks, int bufferSize)
 
 StreamReader (const System::String &path)
 
 StreamReader (const System::String &path, bool detectEncodingFromByteOrderMarks)
 
 StreamReader (const System::String &path, const EncodingPtr &encoding)
 
 StreamReader (const System::String &path, const EncodingPtr &encoding, bool detectEncodingFromByteOrderMarks)
 
 StreamReader (const System::String &path, const EncodingPtr &encoding, bool detectEncodingFromByteOrderMarks, int bufferSize)
 
 ~StreamReader ()
 Destructor. More...
 
virtual int Peek () override
 
virtual int Read () override
 
virtual int Read (ArrayPtr< char_t > buffer, int index, int count) override
 
virtual String ReadLine () override
 
virtual String ReadToEnd () override
 
virtual void Close () override
 Closes the current and underlying streams. More...
 
bool get_EndOfStream ()
 Returns a value that indicates if the end of of stream has been reached. More...
 
EncodingPtr get_CurrentEncoding ()
 Returns the currently used encoding. More...
 
SharedPtr< Streamget_BaseStream () const
 Returns a shared pointer to an object that represents the underlying stream. More...
 
- Public Member Functions inherited from System::IO::TextReader
virtual void Dispose () override
 Releases all resources used by the current object and closes the undelying stream. More...
 
virtual int ReadBlock (ArrayPtr< char_t > buffer, int index, int count)
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Protected Member Functions

void Dispose (bool disposing) override
 
- Protected Member Functions inherited from System::IO::TextReader
 TextReader ()
 Constructs a new instance of TextReader. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 

Detailed Description

Represents a reader that reads characters from a byte stream. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Constructor & Destructor Documentation

◆ StreamReader() [1/10]

System::IO::StreamReader::StreamReader ( const SharedPtr< Stream > &  stream)

Constructs an instance of StreamReader object that reads characters from the specified underlying stream using UTF-8 encoding and a buffer with default size of 1024 bytes.

Parameters
streamThe underlying stream to read characters from

◆ StreamReader() [2/10]

System::IO::StreamReader::StreamReader ( const SharedPtr< Stream > &  stream,
bool  detectEncodingFromByteOrderMarks 
)

Constructs an instance of StreamReader object that reads characters from the specified underlying stream using UTF-8 encoding and a buffer with default size of 1024 bytes. A parameter specifies if byte order mark detection should be enabled.

Parameters
streamThe underlying stream to read characters from
detectEncodingFromByteOrderMarksTrue to look for byte order marks at the beginning of the stream, otherwise - false

◆ StreamReader() [3/10]

System::IO::StreamReader::StreamReader ( const SharedPtr< Stream > &  stream,
const EncodingPtr encoding 
)

Constructs an instance of StreamReader object that reads characters from the specified underlying stream using the specified encoding and a buffer with default size of 1024 bytes.

Parameters
streamThe underlying stream to read characters from
encodingThe encoding to use

◆ StreamReader() [4/10]

System::IO::StreamReader::StreamReader ( const SharedPtr< Stream > &  stream,
const EncodingPtr encoding,
bool  detectEncodingFromByteOrderMarks 
)

Constructs an instance of StreamReader object that reads characters from the specified underlying stream using the specified encoding and a buffer with default size of 1024 bytes. A parameter specifies if byte order mark detection should be enabled.

Parameters
streamThe underlying stream to read characters from
encodingThe encoding to use
detectEncodingFromByteOrderMarksTrue to look for byte order marks at the beginning of the stream, otherwise - false

◆ StreamReader() [5/10]

System::IO::StreamReader::StreamReader ( const SharedPtr< Stream > &  stream,
const EncodingPtr encoding,
bool  detectEncodingFromByteOrderMarks,
int  bufferSize 
)

Constructs an instance of StreamReader object that reads characters from the specified underlying stream using the specified encoding and a buffer of the specified size. A parameter specifies if byte order mark detection should be enabled.

Parameters
streamThe underlying stream to read characters from
encodingThe encoding to use
detectEncodingFromByteOrderMarksTrue to look for byte order marks at the beginning of the stream, otherwise - false
bufferSizeThe minimum size of the buffer in bytes

◆ StreamReader() [6/10]

System::IO::StreamReader::StreamReader ( const System::String path)

Constructs an instance of StreamReader object that reads characters from the specified file using UTF-8 encoding and a buffer with default size of 4096 bytes.

Parameters
pathThe path of the file to read characters from

◆ StreamReader() [7/10]

System::IO::StreamReader::StreamReader ( const System::String path,
bool  detectEncodingFromByteOrderMarks 
)

Constructs an instance of StreamReader object that reads characters from the specified file using UTF-8 encoding and a buffer with default size of 4096 bytes. A parameter specifies if byte order mark detection should be enabled.

Parameters
pathThe path of the file to read characters from
detectEncodingFromByteOrderMarksTrue to look for byte order marks at the beginning of the file, otherwise - false

◆ StreamReader() [8/10]

System::IO::StreamReader::StreamReader ( const System::String path,
const EncodingPtr encoding 
)

Constructs an instance of StreamReader object that reads characters from the specified file using the specified encoding and a buffer with default size of 4096 bytes.

Parameters
pathThe path of the file to read characters from
encodingThe encoding to use

◆ StreamReader() [9/10]

System::IO::StreamReader::StreamReader ( const System::String path,
const EncodingPtr encoding,
bool  detectEncodingFromByteOrderMarks 
)

Constructs an instance of StreamReader object that reads characters from the specified underlying stream using the specified encoding and a buffer with default size of 4096 bytes. A parameter specifies if byte order mark detection should be enabled.

Parameters
pathThe path of the file to read characters from
encodingThe encoding to use
detectEncodingFromByteOrderMarksTrue to look for byte order marks at the beginning of the file, otherwise - false

◆ StreamReader() [10/10]

System::IO::StreamReader::StreamReader ( const System::String path,
const EncodingPtr encoding,
bool  detectEncodingFromByteOrderMarks,
int  bufferSize 
)

Constructs an instance of StreamReader object that reads characters from the specified file using the specified encoding and a buffer of the specified size. A parameter specifies if byte order mark detection should be enabled.

Parameters
pathThe path of the file to read characters from
encodingThe encoding to use
detectEncodingFromByteOrderMarksTrue to look for byte order marks at the beginning of the file, otherwise - false
bufferSizeThe minimum size of the buffer in bytes

◆ ~StreamReader()

System::IO::StreamReader::~StreamReader ( )

Destructor.

Member Function Documentation

◆ Close()

virtual void System::IO::StreamReader::Close ( )
overridevirtual

Closes the current and underlying streams.

Reimplemented from System::IO::TextReader.

◆ Dispose()

void System::IO::StreamReader::Dispose ( bool  disposing)
overrideprotectedvirtual

Releases all resources used by the current object and closes the undelying stream.

Parameters
disposingSpecifies whether the undelying stream should be closed.

Reimplemented from System::IO::TextReader.

◆ get_BaseStream()

SharedPtr<Stream> System::IO::StreamReader::get_BaseStream ( ) const
inline

Returns a shared pointer to an object that represents the underlying stream.

◆ get_CurrentEncoding()

EncodingPtr System::IO::StreamReader::get_CurrentEncoding ( )
inline

Returns the currently used encoding.

◆ get_EndOfStream()

bool System::IO::StreamReader::get_EndOfStream ( )

Returns a value that indicates if the end of of stream has been reached.

◆ Peek()

virtual int System::IO::StreamReader::Peek ( )
overridevirtual

Reads a single character from the stream without changing the stream's read cursor.

Returns
Read character encoded with UTF-16 encoding; if the read character is represented by two codepoints in UTF-16 encoding then only the high surragate is returned; if no character was read -1 is returned

Reimplemented from System::IO::TextReader.

◆ Read() [1/2]

virtual int System::IO::StreamReader::Read ( )
overridevirtual

Reads a single character from the stream.

Returns
Read character encoded with UTF-16 encoding; if the read character is represented by two codepoints in UTF-16 encoding then only the high surragate is returned.

Reimplemented from System::IO::TextReader.

◆ Read() [2/2]

virtual int System::IO::StreamReader::Read ( ArrayPtr< char_t >  buffer,
int  index,
int  count 
)
overridevirtual

Reads the specified number of characters from the stream, converts them to UTF-16 encoding and writes the resulting UTF-16 characters to the specified character array starting at the specified position.

Parameters
bufferThe UTF-16 character array to write the characters read from the stream to
indexA 0-based index in buffer at which to start writing
countThe number of characters to read from the stream
Returns
The number of characters read from the stream

Reimplemented from System::IO::TextReader.

◆ ReadLine()

virtual String System::IO::StreamReader::ReadLine ( )
overridevirtual

Reads characters from the stream until the end of the current line.

Returns
A string containing the read characters

Reimplemented from System::IO::TextReader.

◆ ReadToEnd()

virtual String System::IO::StreamReader::ReadToEnd ( )
overridevirtual

Reads characters from the stream until the end of the stream.

Returns
A string containing the read characters

Reimplemented from System::IO::TextReader.