System::IO::BinaryReader Class Reference

Represents a reader that reads primitive data types as binary data in particular encoding. More...

Inherits System::IDisposable.

Public Member Functions

 BinaryReader (const SharedPtr< Stream > &input)
 
 BinaryReader (const SharedPtr< Stream > &input, const SharedPtr< Text::Encoding > &encoding)
 
 BinaryReader (const SharedPtr< Stream > &input, const SharedPtr< Text::Encoding > &encoding, bool leaveOpen)
 
virtual SharedPtr< Streamget_BaseStream ()
 Returns the input stream. More...
 
virtual void Close ()
 Closes the current BinaryReader object and the underlying input stream. More...
 
virtual ~BinaryReader ()
 Destructor. More...
 
virtual int PeekChar ()
 
virtual int Read ()
 
virtual int Read (ArrayPtr< uint8_t > buffer, int index, int count)
 
virtual int Read (ArrayPtr< char_t > buffer, int index, int count)
 
virtual bool ReadBoolean ()
 
virtual uint8_t ReadByte ()
 
virtual ArrayPtr< uint8_t > ReadBytes (int count)
 
virtual char_t ReadChar ()
 
virtual ArrayPtr< char_t > ReadChars (int count)
 
virtual double ReadDouble ()
 
virtual int16_t ReadInt16 ()
 
virtual int ReadInt32 ()
 
virtual int64_t ReadInt64 ()
 
virtual int8_t ReadSByte ()
 
virtual String ReadString ()
 TODO. More...
 
virtual float ReadSingle ()
 
virtual uint16_t ReadUInt16 ()
 
virtual uint32_t ReadUInt32 ()
 
virtual uint64_t ReadUInt64 ()
 
virtual Decimal ReadDecimal ()
 
virtual void Dispose () override
 Releases all resources used by the current object and closes the undelying 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...
 
void SharedRefRemoved ()
 Decrements shared reference count and deletes object if it hits zero. Shouldn't be called directly; instead, use smart pointers or ThisProtector. 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 FreeOrDetectCycles (int count)
 Reacts on shared reference counter decrement. Shouldn't be called directly, use smart pointers instead. If neccessary, deletes the object. If allowed, initiates loop references lookup. 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. TypeInfo structure descibing the type to test current object against. More...
 
void __FreePointers ()
 Resets all smart pointers stored inside this object directly (in fields) or indirectly (in value type fields). Used by memory management systems, shouldn't be called directly. 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

virtual void FillBuffer (int numBytes)
 
int Read7BitEncodedInt ()
 TODO. More...
 
- Protected Member Functions inherited from System::Object
virtual shared_members_type GetSharedMembers ()
 Gets list of non-null shared pointers. More...
 
template<class Container , typename Value = typename Container::value_type>
std::enable_if<!System::IsSmartPtr< Value >::value &&!System::detail::is_a< Value, std::pair >::value, void >::type PopulateSharedMembers (Object::shared_members_type &, const char *, Container &)
 
template<class Container , typename Value = typename Container::value_type>
std::enable_if< System::IsSmartPtr< Value >::value, void >::type PopulateSharedMembers (Object::shared_members_type &data, const char *name, Container &container)
 
template<class Container , typename Value = typename Container::value_type>
std::enable_if< System::detail::is_a< Value, std::pair >::value &&!System::IsSmartPtr< typename Value::first_type >::value &&!System::IsSmartPtr< typename Value::second_type >::value, void >::type PopulateSharedMembers (Object::shared_members_type &, const char *, Container &)
 
template<class Container , typename Value = typename Container::value_type>
std::enable_if< System::detail::is_a< Value, std::pair >::value &&System::IsSmartPtr< typename Value::first_type >::value &&!System::IsSmartPtr< typename Value::second_type >::value, void >::type PopulateSharedMembers (Object::shared_members_type &data, const char *name, Container &container)
 
template<class Container , typename Value = typename Container::value_type>
std::enable_if< System::detail::is_a< Value, std::pair >::value &&!System::IsSmartPtr< typename Value::first_type >::value &&System::IsSmartPtr< typename Value::second_type >::value, void >::type PopulateSharedMembers (Object::shared_members_type &data, const char *name, Container &container)
 
template<class Container , typename Value = typename Container::value_type>
std::enable_if< System::detail::is_a< Value, std::pair >::value &&System::IsSmartPtr< typename Value::first_type >::value &&System::IsSmartPtr< typename Value::second_type >::value, void >::type PopulateSharedMembers (Object::shared_members_type &data, const char *name, Container &container)
 

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 ()
 Impleemnts C# typeof(System.Object) construct. More...
 
static void __FreeStaticPointers ()
 Implementation of cleanup_tests option. Deletes shared members of type it is called for. Nothing to delete at this level. More...
 
- Protected Types inherited from System::Object
template<class T >
using supports_free_pointers = decltype(__SupportsFreePointers(std::declval< T * >()))
 Checks if T type supports __FreePointers() method. More...
 
- Static Protected Member Functions inherited from System::Object
template<class T , class Check = decltype(std::declval<T*>()->__FreePointers())>
static std::true_type __SupportsFreePointers (T *)
 Formal function for template magic to check if type T supports __FreePointers() method. More...
 
static std::false_type __SupportsFreePointers (...)
 Formal function for template magic to check if type T supports __FreePointers() method. More...
 
template<class T >
static std::enable_if< supports_free_pointers< T >::value, void >::type __DoFreePointers (T &t)
 
template<class T >
static std::enable_if<!supports_free_pointers< T >::value &&!std::is_fundamental< T >::value &&!std::is_enum< T >::value &&!std::is_const< T >::value, void >::type __DoFreePointers (const T &)
 
template<class T >
static std::enable_if<!supports_free_pointers< T >::value &&!std::is_fundamental< T >::value &&!std::is_enum< T >::value &&std::is_const< T >::value, void >::type __DoFreePointers (T &)
 
template<class T >
static std::enable_if< std::is_fundamental< T >::value||std::is_enum< T >::value, void >::type __DoFreePointers (T)
 

Detailed Description

Represents a reader that reads primitive data types as binary data in particular encoding.

Constructor & Destructor Documentation

◆ BinaryReader() [1/3]

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]

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]

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 System::IO::BinaryReader::~BinaryReader ( )
virtual

Destructor.

Member Function Documentation

◆ Close()

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

Closes the current BinaryReader object and the underlying input stream.

◆ Dispose()

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

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

Reimplemented from System::IDisposable.

◆ FillBuffer()

virtual void System::IO::BinaryReader::FillBuffer ( int  numBytes)
protectedvirtual

Reads the specified number of bytes from the input stream to the intrenal buffer.

Parameters
numBytesThe number of bytes to read

◆ get_BaseStream()

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

Returns the input stream.

◆ PeekChar()

virtual 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 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 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 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

◆ Read7BitEncodedInt()

int System::IO::BinaryReader::Read7BitEncodedInt ( )
protected

TODO.

◆ ReadBoolean()

virtual 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 uint8_t System::IO::BinaryReader::ReadByte ( )
virtual

Reads a single byte from the input stream.

Returns
The byte read

◆ ReadBytes()

virtual 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 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 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 Decimal System::IO::BinaryReader::ReadDecimal ( )
virtual

NOT IMPLEMENTED

Exceptions
NotImplementedExceptionalways

◆ ReadDouble()

virtual 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 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 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 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 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 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 String System::IO::BinaryReader::ReadString ( )
virtual

TODO.

◆ ReadUInt16()

virtual 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 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 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