Asposecpplib
System::IO::TextReader Class Reference

A base class for classes that represent readers that read sequences of characters from different sources. 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. More...

Inherits System::IDisposable.

Inherited by System::IO::StreamReader, and System::IO::StringReader.

Public Member Functions

virtual void Dispose () override
 Releases all resources used by the current object and closes the undelying stream. More...
 
virtual void Close ()
 Closes the stream and releases aquired resources. More...
 
virtual int Peek ()
 Reads a single character from the stream without changing the stream's read cursor. More...
 
virtual int Read ()
 Reads a single character from the stream. More...
 
virtual int Read (ArrayPtr< char_t > buffer, int index, int count)
 Reads the specified number of characters from the stream and writes them to the specified character array starting at the specified position. More...
 
virtual int ReadBlock (ArrayPtr< char_t > buffer, int index, int count)
 Reads the specified maximum number of characters from the current text reader and writes the data to a buffer, starting at the specified index. More...
 
virtual System::String ReadLine ()
 Reads characters from the stream until the end of the current line. More...
 
virtual System::String ReadToEnd ()
 Reads characters from the stream until the end of the stream. More...
 
- 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 reference 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 int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () 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 (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Protected Member Functions

 TextReader ()
 Constructs a new instance of TextReader. More...
 
virtual void Dispose (bool disposing)
 Releases all resources used by the current object and closes the undelying stream. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. 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 ()
 Implements C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 

Detailed Description

A base class for classes that represent readers that read sequences of characters from different sources. 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

◆ TextReader()

System::IO::TextReader::TextReader ( )
inlineprotected

Constructs a new instance of TextReader.

Member Function Documentation

◆ Close()

virtual void System::IO::TextReader::Close ( )
inlinevirtual

Closes the stream and releases aquired resources.

Reimplemented in System::IO::StringReader, and System::IO::StreamReader.

◆ Dispose() [1/2]

virtual void System::IO::TextReader::Dispose ( )
inlineoverridevirtual

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

Reimplemented from System::IDisposable.

Reimplemented in System::IO::StreamReader, System::IO::StringReader, and System::IO::StreamReader.

◆ Dispose() [2/2]

virtual void System::IO::TextReader::Dispose ( bool  disposing)
protectedvirtual

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

Parameters
disposingSpecifies whether the undelying stream should be closed.

Reimplemented in System::IO::StringReader, and System::IO::StreamReader.

◆ Peek()

virtual int System::IO::TextReader::Peek ( )
inlinevirtual

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 in System::IO::StringReader, and System::IO::StreamReader.

◆ Read() [1/2]

virtual int System::IO::TextReader::Read ( )
inlinevirtual

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 in System::IO::StringReader, and System::IO::StreamReader.

◆ Read() [2/2]

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

Reads the specified number of characters from the stream and writes them 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 in System::IO::StringReader, and System::IO::StreamReader.

◆ ReadBlock()

virtual int System::IO::TextReader::ReadBlock ( ArrayPtr< char_t >  buffer,
int  index,
int  count 
)
virtual

Reads the specified maximum number of characters from the current text reader and writes the data to a buffer, starting at the specified index.

Parameters
bufferA character buffer to write the read data to
indexA 0-based index in buffer to start writing at
countThe maximum number of characters to read
Returns
The actual number of characters read

◆ ReadLine()

virtual System::String System::IO::TextReader::ReadLine ( )
virtual

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

Returns
A string containing the read characters

Reimplemented in System::IO::StringReader, and System::IO::StreamReader.

◆ ReadToEnd()

virtual System::String System::IO::TextReader::ReadToEnd ( )
virtual

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

Returns
A string containing the read characters

Reimplemented in System::IO::StringReader, and System::IO::StreamReader.