Asposecpplib
System::IO::BinaryReader Class Reference

Represents a reader that reads primitive data types as binary data in particular encoding. 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.

Public Member Functions

ASPOSECPP_SHARED_API BinaryReader (const SharedPtr< Stream > &input)
 Constructs an instance of BinaryReader class that reads data from the specified stream using UTF-8 encoding. More...
 
ASPOSECPP_SHARED_API BinaryReader (const SharedPtr< Stream > &input, const SharedPtr< Text::Encoding > &encoding)
 Constructs an instance of BinaryReader class that reads data from the specified stream using the specified encoding. More...
 
ASPOSECPP_SHARED_API BinaryReader (const SharedPtr< Stream > &input, const SharedPtr< Text::Encoding > &encoding, bool leaveOpen)
 Constructs an instance of BinaryReader class that reads data from the specified stream using the specified encoding. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< Streamget_BaseStream ()
 Returns the input stream. More...
 
virtual ASPOSECPP_SHARED_API void Close ()
 Closes the current BinaryReader object and the underlying input stream. More...
 
virtual ASPOSECPP_SHARED_API ~BinaryReader ()
 Destructor. More...
 
virtual ASPOSECPP_SHARED_API int PeekChar ()
 Reads a single character from the input stream without changing the stream's read cursor. More...
 
virtual ASPOSECPP_SHARED_API int Read ()
 Reads a single character from the input stream. More...
 
virtual ASPOSECPP_SHARED_API int Read (ArrayPtr< uint8_t > buffer, int index, int count)
 Reads the specified number of bytes from the input stream and writes them to the specified byte array. More...
 
virtual ASPOSECPP_SHARED_API int Read (ArrayPtr< char_t > buffer, int index, int count)
 Reads the specified number of characters from the input stream, converts them to UTF-16 encoding and writes the resulting UTF-16 characters to the specified character array starting at the specified position. More...
 
virtual ASPOSECPP_SHARED_API bool ReadBoolean ()
 Reads a single byte from the input stream and returns its boolean representation. More...
 
virtual ASPOSECPP_SHARED_API uint8_t ReadByte ()
 Reads a single byte from the input stream. More...
 
virtual ASPOSECPP_SHARED_API ArrayPtr< uint8_t > ReadBytes (int count)
 Reads the specified number of bytes from the input stream. More...
 
virtual ASPOSECPP_SHARED_API char_t ReadChar ()
 Reads a single character from the input stream. More...
 
virtual ASPOSECPP_SHARED_API ArrayPtr< char_t > ReadChars (int count)
 Reads the specified number of characters from the input stream and returns them in UTF-16 ecoding. More...
 
virtual ASPOSECPP_SHARED_API double ReadDouble ()
 Reads 8 bytes from the input stream and returns them as a double-precision floating point value. More...
 
virtual ASPOSECPP_SHARED_API int16_t ReadInt16 ()
 Reads 2 bytes from the input stream and returns them as a 16-bit integer value. More...
 
virtual ASPOSECPP_SHARED_API int ReadInt32 ()
 Reads 4 bytes from the input stream and returns them as a 32-bit integer value. More...
 
virtual ASPOSECPP_SHARED_API int64_t ReadInt64 ()
 Reads 8 bytes from the input stream and returns them as a 64-bit integer value. More...
 
virtual ASPOSECPP_SHARED_API int8_t ReadSByte ()
 Reads a single byte from the input stream and returns it as a signed 8-bit integer value. More...
 
virtual ASPOSECPP_SHARED_API String ReadString ()
 Reads a string from the current stream. The string is prefixed with the length, encoded as an integer seven bits at a time. More...
 
virtual ASPOSECPP_SHARED_API float ReadSingle ()
 Reads 4 bytes from the input stream and returns them as a single-precision floating point value. More...
 
virtual ASPOSECPP_SHARED_API uint16_t ReadUInt16 ()
 Reads 2 bytes from the input stream and returns them as an unsigned 16-bit integer value. More...
 
virtual ASPOSECPP_SHARED_API uint32_t ReadUInt32 ()
 Reads 4 bytes from the input stream and returns them as an unsigned 32-bit integer value. More...
 
virtual ASPOSECPP_SHARED_API uint64_t ReadUInt64 ()
 Reads 8 bytes from the input stream and returns them as an unsigned 64-bit integer value. More...
 
virtual ASPOSECPP_SHARED_API Decimal ReadDecimal ()
 NOT IMPLEMENTED. More...
 
virtual ASPOSECPP_SHARED_API void Dispose () override
 Releases all resources used by the current object and closes the undelying stream. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API 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...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API 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)
 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...
 
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...
 

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 primitive data types as binary data in particular encoding. 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

◆ BinaryReader() [1/3]

ASPOSECPP_SHARED_API System::IO::BinaryReader::BinaryReader ( const SharedPtr< Stream > &  input)

Constructs an instance of BinaryReader class that reads data from the specified stream using UTF-8 encoding.

Parameters
inputThe input stream

◆ BinaryReader() [2/3]

ASPOSECPP_SHARED_API System::IO::BinaryReader::BinaryReader ( const SharedPtr< Stream > &  input,
const SharedPtr< Text::Encoding > &  encoding 
)

Constructs an instance of BinaryReader class that reads data from the specified stream using the specified encoding.

Parameters
inputThe input stream
encodingThe encoding to use

◆ BinaryReader() [3/3]

ASPOSECPP_SHARED_API System::IO::BinaryReader::BinaryReader ( const SharedPtr< Stream > &  input,
const SharedPtr< Text::Encoding > &  encoding,
bool  leaveOpen 
)

Constructs an instance of BinaryReader class that reads data from the specified stream using the specified encoding.

Parameters
inputThe input stream
encodingThe encoding to use
leaveOpenSpecifies whether the stream input should be left open (true) after the current object has been disposed or not (false)

◆ ~BinaryReader()

virtual ASPOSECPP_SHARED_API System::IO::BinaryReader::~BinaryReader ( )
virtual

Destructor.

Member Function Documentation

◆ Close()

virtual ASPOSECPP_SHARED_API void System::IO::BinaryReader::Close ( )
virtual

Closes the current BinaryReader object and the underlying input stream.

◆ Dispose()

virtual ASPOSECPP_SHARED_API void System::IO::BinaryReader::Dispose ( )
overridevirtual

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

Reimplemented from System::IDisposable.

◆ get_BaseStream()

virtual ASPOSECPP_SHARED_API SharedPtr<Stream> System::IO::BinaryReader::get_BaseStream ( )
virtual

Returns the input stream.

◆ PeekChar()

virtual ASPOSECPP_SHARED_API int System::IO::BinaryReader::PeekChar ( )
virtual

Reads a single character from the input 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

◆ Read() [1/3]

virtual ASPOSECPP_SHARED_API int System::IO::BinaryReader::Read ( )
virtual

Reads a single character from the input 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.

◆ Read() [2/3]

virtual ASPOSECPP_SHARED_API int System::IO::BinaryReader::Read ( ArrayPtr< uint8_t >  buffer,
int  index,
int  count 
)
virtual

Reads the specified number of bytes from the input stream and writes them to the specified byte array.

Parameters
bufferThe byte array to write the read bytes to
indexA 0-based position in buffer to start writing at
countThe number of bytes to read
Returns
The number of bytes read

◆ Read() [3/3]

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

Reads the specified number of characters from the input 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 input 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 input stream

◆ ReadBoolean()

virtual ASPOSECPP_SHARED_API bool System::IO::BinaryReader::ReadBoolean ( )
virtual

Reads a single byte from the input stream and returns its boolean representation.

Returns
True if the read byte is not equal to 0, otherwise - false

◆ ReadByte()

virtual ASPOSECPP_SHARED_API uint8_t System::IO::BinaryReader::ReadByte ( )
virtual

Reads a single byte from the input stream.

Returns
The byte read

◆ ReadBytes()

virtual ASPOSECPP_SHARED_API ArrayPtr<uint8_t> System::IO::BinaryReader::ReadBytes ( int  count)
virtual

Reads the specified number of bytes from the input stream.

Parameters
countThe number of bytes to read
Returns
A byte array containing the read bytes

◆ ReadChar()

virtual ASPOSECPP_SHARED_API char_t System::IO::BinaryReader::ReadChar ( )
virtual

Reads a single character from the input stream.

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

◆ ReadChars()

virtual ASPOSECPP_SHARED_API ArrayPtr<char_t> System::IO::BinaryReader::ReadChars ( int  count)
virtual

Reads the specified number of characters from the input stream and returns them in UTF-16 ecoding.

Parameters
countThe number of characters to read from the input stream
Returns
An array containing the read characters

◆ ReadDecimal()

virtual ASPOSECPP_SHARED_API Decimal System::IO::BinaryReader::ReadDecimal ( )
virtual

NOT IMPLEMENTED.

Exceptions
NotImplementedExceptionalways

◆ ReadDouble()

virtual ASPOSECPP_SHARED_API double System::IO::BinaryReader::ReadDouble ( )
virtual

Reads 8 bytes from the input stream and returns them as a double-precision floating point value.

Returns
A double-precision floating point value read

◆ ReadInt16()

virtual ASPOSECPP_SHARED_API int16_t System::IO::BinaryReader::ReadInt16 ( )
virtual

Reads 2 bytes from the input stream and returns them as a 16-bit integer value.

Returns
A 16-bit integer value read

◆ ReadInt32()

virtual ASPOSECPP_SHARED_API int System::IO::BinaryReader::ReadInt32 ( )
virtual

Reads 4 bytes from the input stream and returns them as a 32-bit integer value.

Returns
A 132-bit integer value read

◆ ReadInt64()

virtual ASPOSECPP_SHARED_API int64_t System::IO::BinaryReader::ReadInt64 ( )
virtual

Reads 8 bytes from the input stream and returns them as a 64-bit integer value.

Returns
A 64-bit integer value read

◆ ReadSByte()

virtual ASPOSECPP_SHARED_API int8_t System::IO::BinaryReader::ReadSByte ( )
virtual

Reads a single byte from the input stream and returns it as a signed 8-bit integer value.

Returns
A signed 8-bit integer value read

◆ ReadSingle()

virtual ASPOSECPP_SHARED_API float System::IO::BinaryReader::ReadSingle ( )
virtual

Reads 4 bytes from the input stream and returns them as a single-precision floating point value.

Returns
A single-precision floating point value read

◆ ReadString()

virtual ASPOSECPP_SHARED_API String System::IO::BinaryReader::ReadString ( )
virtual

Reads a string from the current stream. The string is prefixed with the length, encoded as an integer seven bits at a time.

Returns
The read string

◆ ReadUInt16()

virtual ASPOSECPP_SHARED_API uint16_t System::IO::BinaryReader::ReadUInt16 ( )
virtual

Reads 2 bytes from the input stream and returns them as an unsigned 16-bit integer value.

Returns
An unsigned 16-bit integer value read

◆ ReadUInt32()

virtual ASPOSECPP_SHARED_API uint32_t System::IO::BinaryReader::ReadUInt32 ( )
virtual

Reads 4 bytes from the input stream and returns them as an unsigned 32-bit integer value.

Returns
An unsigned 32-bit integer value read

◆ ReadUInt64()

virtual ASPOSECPP_SHARED_API uint64_t System::IO::BinaryReader::ReadUInt64 ( )
virtual

Reads 8 bytes from the input stream and returns them as an unsigned 64-bit integer value.

Returns
An unsigned 64-bit integer value read