System::IO::STDIOStreamWrapperBase< T, typename > Class Template Referenceabstract

Represents a base class for System.IO.Stream-like wrappers. 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::IO::Stream.

Inherited by System::IO::BasicSTDIStreamWrapper< T, typename > [virtual], and System::IO::BasicSTDOStreamWrapper< T, typename > [virtual].

Public Types

using ThisType = STDIOStreamWrapperBase< T >
 
using BaseType = Stream
 
using ThisTypeBaseTypesInfo = BaseTypesInfo< BaseType >
 
using char_type = typename T::char_type
 
using traits_type = typename T::traits_type
 
using int_type = typename T::int_type
 
using pos_type = typename T::pos_type
 
using off_type = typename T::off_type
 
- Public Types inherited from System::IO::Stream
typedef SharedPtr< StreamPtr
 An alias for a shared pointer to this class. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

 RTTI_INFO_TEMPLATE_CLASS (ThisType, ThisTypeBaseTypesInfo)
 RTTI information. More...
 
 STDIOStreamWrapperBase (const STDIOStreamWrapperBase &)=delete
 Copy constructor. Deleted. More...
 
STDIOStreamWrapperBaseoperator= (const STDIOStreamWrapperBase &)=delete
 Copy assignment operator. Deleted. More...
 
virtual int64_t Seek (int64_t offset, SeekOrigin origin) override
 Sets the position of the stream represented by the current object. More...
 
virtual void set_Position (int64_t value) override
 Sets the stream's position. More...
 
virtual int64_t get_Position () const override
 Returns current position of the stream. More...
 
virtual int64_t get_Length () const override
 Returns length of the stream. More...
 
virtual bool get_CanRead () const override
 Determines if the stream supports reading. More...
 
virtual bool get_CanSeek () const override
 Determines if the stream supports seeking. More...
 
virtual bool get_CanWrite () const override
 Determines if the stream supports writing. More...
 
- Public Member Functions inherited from System::IO::Stream
virtual int ReadByte ()
 Reads a single byte from the stream and returns a 32-bit integer value equivalent to the value of the read byte. More...
 
virtual void WriteByte (uint8_t value)
 Writes the specified unsigned 8-bit integer value to the stream. More...
 
virtual int32_t Read (const ArrayPtr< uint8_t > &buffer, int32_t offset, int32_t count)=0
 Reads the specified number of bytes from the stream and writes them to the specified byte array. More...
 
virtual void Write (const ArrayPtr< uint8_t > &buffer, int32_t offset, int32_t count)=0
 Writes the specified subrange of bytes from the specified byte array to the stream. More...
 
virtual int32_t Read (const System::Details::ArrayView< uint8_t > &buffer, int32_t offset, int32_t count)
 Reads the specified number of bytes from the stream and writes them to the specified byte array. More...
 
virtual void Write (const System::Details::ArrayView< uint8_t > &buffer, int32_t offset, int32_t count)
 Writes the specified subrange of bytes from the specified byte array to the stream. More...
 
template<std::size_t N>
int32_t Read (const System::Details::StackArray< uint8_t, N > &buffer, int32_t offset, int32_t count)
 Reads the specified number of bytes from the stream and writes them to the specified byte array. More...
 
template<std::size_t N>
void Write (const System::Details::StackArray< uint8_t, N > &buffer, int32_t offset, int32_t count)
 Writes the specified subrange of bytes from the specified byte array to the stream. More...
 
virtual void SetLength (int64_t value)=0
 Sets the length of the stream represented by the current object. More...
 
virtual void Flush ()=0
 Clears this stream's buffers and writes all buffered data to the underlying storage. More...
 
virtual void Close ()
 Closes the stream. More...
 
void Dispose () override
 Releases all resources used by the current object and closes the stream. More...
 
virtual System::SharedPtr< System::IAsyncResultBeginRead (System::ArrayPtr< uint8_t > buffer, int offset, int count, System::AsyncCallback callback, System::SharedPtr< System::Object > state)
 Initiates an asynchronous read operation. More...
 
virtual System::SharedPtr< System::IAsyncResultBeginWrite (System::ArrayPtr< uint8_t > buffer, int offset, int count, System::AsyncCallback callback, System::SharedPtr< System::Object > state)
 Initiates an asynchronous write operation. More...
 
virtual int EndRead (System::SharedPtr< System::IAsyncResult > asyncResult)
 Waits until the specified asynchronous read operation completes. More...
 
virtual void EndWrite (System::SharedPtr< System::IAsyncResult > asyncResult)
 Ends an asynchronous write operation. Waits until the specified asynchronous write operation completes. More...
 
void CopyTo (const SharedPtr< Stream > &destination)
 Copies bytes to the specified stream. More...
 
void CopyTo (const SharedPtr< Stream > &destination, int32_t buffer_size)
 Copies bytes to the specified stream, using the specified buffer size. More...
 
virtual bool get_CanTimeout () const
 Gets a value that determines whether the current stream can time out. More...
 
virtual void set_ReadTimeout (int timeout)
 Sets a value that determines whether the current stream can time out. More...
 
virtual int get_ReadTimeout () const
 Gets a value, in milliseconds, that determines how long the stream will attempt to read before timing out. More...
 
virtual void set_WriteTimeout (int timeout)
 Sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out. More...
 
virtual int get_WriteTimeout () const
 Gets a value, in milliseconds, that determines how long the stream will attempt to write before timing out. 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

 STDIOStreamWrapperBase (std::basic_ios< char_type, traits_type > &str, STDIOStreamWrappingMode mode=STDIOStreamWrappingMode::Binary, bool can_read=false, bool can_write=false, bool can_seek=false, STDIOStreamPositionPreference pref_pos=STDIOStreamPositionPreference::Zero)
 Constructs a new instance of the STDIOStreamWrapperBase. More...
 
virtual int64_t Pubseekpos (int64_t value)=0
 Seeks positions of read or write or both on value. More...
 
virtual void Check () const
 Check if the stream has been modified outside the wrapper. More...
 
virtual void Sync ()=0
 Synchronizes positions of read or write or both. More...
 
void DecodeElem (int_type meta)
 Decodes meta and store result in the last decoded element storage. More...
 
void DecodeElem (int_type meta, ArrayPtr< uint8_t > &destination)
 Decodes meta and store result in the destination. More...
 
char_type EncodeElem ()
 Encodes the last decoded element storage. More...
 
char_type EncodeElem (uint8_t *source)
 Encodes source. More...
 
void EncodeElem (uint8_t *source, char_type *destination)
 Encodes source to destination. More...
 
- Protected Member Functions inherited from System::IO::Stream
virtual void Dispose (bool disposing)
 Releases all resources used by the current object and closes the stream. More...
 

Additional Inherited Members

- 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...
 
- Static Public Attributes inherited from System::IO::Stream
static const System::SharedPtr< StreamNull
 A stream with no underlying storage. More...
 

Detailed Description

template<typename T, typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
class System::IO::STDIOStreamWrapperBase< T, typename >

Represents a base class for System.IO.Stream-like wrappers. 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.

Member Typedef Documentation

◆ BaseType

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
using System::IO::STDIOStreamWrapperBase< T, typename >::BaseType = Stream

◆ char_type

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
using System::IO::STDIOStreamWrapperBase< T, typename >::char_type = typename T::char_type

◆ int_type

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
using System::IO::STDIOStreamWrapperBase< T, typename >::int_type = typename T::int_type

◆ off_type

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
using System::IO::STDIOStreamWrapperBase< T, typename >::off_type = typename T::off_type

◆ pos_type

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
using System::IO::STDIOStreamWrapperBase< T, typename >::pos_type = typename T::pos_type

◆ ThisType

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
using System::IO::STDIOStreamWrapperBase< T, typename >::ThisType = STDIOStreamWrapperBase<T>

◆ ThisTypeBaseTypesInfo

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
using System::IO::STDIOStreamWrapperBase< T, typename >::ThisTypeBaseTypesInfo = BaseTypesInfo<BaseType>

◆ traits_type

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
using System::IO::STDIOStreamWrapperBase< T, typename >::traits_type = typename T::traits_type

Constructor & Destructor Documentation

◆ STDIOStreamWrapperBase() [1/2]

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
System::IO::STDIOStreamWrapperBase< T, typename >::STDIOStreamWrapperBase ( const STDIOStreamWrapperBase< T, typename > &  )
delete

Copy constructor. Deleted.

◆ STDIOStreamWrapperBase() [2/2]

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
System::IO::STDIOStreamWrapperBase< T, typename >::STDIOStreamWrapperBase ( std::basic_ios< char_type, traits_type > &  str,
STDIOStreamWrappingMode  mode = STDIOStreamWrappingMode::Binary,
bool  can_read = false,
bool  can_write = false,
bool  can_seek = false,
STDIOStreamPositionPreference  pref_pos = STDIOStreamPositionPreference::Zero 
)
inlineprotected

Constructs a new instance of the STDIOStreamWrapperBase.

Parameters
strA reference to the std::iostream-like stream
modeWrapping mode
can_readCanRead flag
can_writeCanWrite flag
can_seekCanSeek flag
pref_posPosition that will prefer as read and write position, if they are different

Member Function Documentation

◆ Check()

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
virtual void System::IO::STDIOStreamWrapperBase< T, typename >::Check ( ) const
inlineprotectedvirtual

◆ DecodeElem() [1/2]

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
void System::IO::STDIOStreamWrapperBase< T, typename >::DecodeElem ( int_type  meta)
inlineprotected

Decodes meta and store result in the last decoded element storage.

Parameters
metaMeta character to decode

◆ DecodeElem() [2/2]

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
void System::IO::STDIOStreamWrapperBase< T, typename >::DecodeElem ( int_type  meta,
ArrayPtr< uint8_t > &  destination 
)
inlineprotected

Decodes meta and store result in the destination.

Parameters
metaMeta character to decode
destinationReference to decoded element storage

◆ EncodeElem() [1/3]

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
char_type System::IO::STDIOStreamWrapperBase< T, typename >::EncodeElem ( )
inlineprotected

Encodes the last decoded element storage.

Returns
Encoded character

◆ EncodeElem() [2/3]

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
char_type System::IO::STDIOStreamWrapperBase< T, typename >::EncodeElem ( uint8_t source)
inlineprotected

Encodes source.

Parameters
sourcePointer to decoded element storage
Returns
Encoded character

◆ EncodeElem() [3/3]

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
void System::IO::STDIOStreamWrapperBase< T, typename >::EncodeElem ( uint8_t source,
char_type destination 
)
inlineprotected

Encodes source to destination.

Parameters
sourcePointer to decoded element storage
destinationPointer to the character to encode

◆ get_CanRead()

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
virtual bool System::IO::STDIOStreamWrapperBase< T, typename >::get_CanRead ( ) const
inlineoverridevirtual

Determines if the stream supports reading.

Implements System::IO::Stream.

◆ get_CanSeek()

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
virtual bool System::IO::STDIOStreamWrapperBase< T, typename >::get_CanSeek ( ) const
inlineoverridevirtual

Determines if the stream supports seeking.

Implements System::IO::Stream.

◆ get_CanWrite()

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
virtual bool System::IO::STDIOStreamWrapperBase< T, typename >::get_CanWrite ( ) const
inlineoverridevirtual

Determines if the stream supports writing.

Implements System::IO::Stream.

◆ get_Length()

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
virtual int64_t System::IO::STDIOStreamWrapperBase< T, typename >::get_Length ( ) const
inlineoverridevirtual

Returns length of the stream.

Implements System::IO::Stream.

◆ get_Position()

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
virtual int64_t System::IO::STDIOStreamWrapperBase< T, typename >::get_Position ( ) const
inlineoverridevirtual

Returns current position of the stream.

Implements System::IO::Stream.

◆ operator=()

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
STDIOStreamWrapperBase& System::IO::STDIOStreamWrapperBase< T, typename >::operator= ( const STDIOStreamWrapperBase< T, typename > &  )
delete

Copy assignment operator. Deleted.

◆ Pubseekpos()

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
virtual int64_t System::IO::STDIOStreamWrapperBase< T, typename >::Pubseekpos ( int64_t  value)
protectedpure virtual

Seeks positions of read or write or both on value.

Parameters
valueSeeked position
Returns
A new position if the seek is successful, otherwise -1

Implemented in System::IO::BasicSTDOStreamWrapper< T, typename >, System::IO::BasicSTDIStreamWrapper< T, typename >, and System::IO::BasicSTDIOStreamWrapper< T, typename >.

◆ RTTI_INFO_TEMPLATE_CLASS()

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
System::IO::STDIOStreamWrapperBase< T, typename >::RTTI_INFO_TEMPLATE_CLASS ( ThisType  ,
ThisTypeBaseTypesInfo   
)

RTTI information.

◆ Seek()

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
virtual int64_t System::IO::STDIOStreamWrapperBase< T, typename >::Seek ( int64_t  offset,
SeekOrigin  origin 
)
inlineoverridevirtual

Sets the position of the stream represented by the current object.

Parameters
offsetThe byte offset relative to a position specified by origin
originSpecifies the position from which and the direction toward which the offset is calculated
Returns
The new position of the stream

Implements System::IO::Stream.

◆ set_Position()

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
virtual void System::IO::STDIOStreamWrapperBase< T, typename >::set_Position ( int64_t  value)
inlineoverridevirtual

Sets the stream's position.

Parameters
valueValue to set the stream's position

Implements System::IO::Stream.

◆ Sync()

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
virtual void System::IO::STDIOStreamWrapperBase< T, typename >::Sync ( )
protectedpure virtual