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

Inherits System::IO::Stream.

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
 
virtual void set_Position (int64_t value) override
 
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 ASPOSECPP_SHARED_API int ReadByte ()
 
virtual ASPOSECPP_SHARED_API void WriteByte (uint8_t value)
 
virtual ASPOSECPP_SHARED_API int32_t Read (const ArrayPtr< uint8_t > &buffer, int32_t offset, int32_t count)=0
 
virtual ASPOSECPP_SHARED_API void Write (const ArrayPtr< uint8_t > &buffer, int32_t offset, int32_t count)=0
 
virtual ASPOSECPP_SHARED_API int32_t Read (const System::Details::ArrayView< uint8_t > &buffer, int32_t offset, int32_t count)
 
virtual ASPOSECPP_SHARED_API void Write (const System::Details::ArrayView< uint8_t > &buffer, int32_t offset, int32_t count)
 
template<std::size_t N>
int32_t Read (const System::Details::StackArray< uint8_t, N > &buffer, int32_t offset, int32_t count)
 
template<std::size_t N>
void Write (const System::Details::StackArray< uint8_t, N > &buffer, int32_t offset, int32_t count)
 
virtual ASPOSECPP_SHARED_API void SetLength (int64_t value)=0
 
virtual ASPOSECPP_SHARED_API 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...
 
ASPOSECPP_SHARED_API void Dispose () override
 Releases all resources used by the current object and closes the stream. More...
 
virtual ASPOSECPP_SHARED_API System::SharedPtr< System::IAsyncResultBeginRead (System::ArrayPtr< uint8_t > buffer, int offset, int count, System::AsyncCallback callback, System::SharedPtr< System::Object > state)
 
virtual ASPOSECPP_SHARED_API System::SharedPtr< System::IAsyncResultBeginWrite (System::ArrayPtr< uint8_t > buffer, int offset, int count, System::AsyncCallback callback, System::SharedPtr< System::Object > state)
 
virtual ASPOSECPP_SHARED_API int EndRead (System::SharedPtr< System::IAsyncResult > asyncResult)
 
virtual ASPOSECPP_SHARED_API void EndWrite (System::SharedPtr< System::IAsyncResult > asyncResult)
 
ASPOSECPP_SHARED_API void CopyTo (const SharedPtr< Stream > &destination)
 
ASPOSECPP_SHARED_API void CopyTo (const SharedPtr< Stream > &destination, int32_t buffer_size)
 
virtual ASPOSECPP_SHARED_API bool get_CanTimeout () const
 
virtual ASPOSECPP_SHARED_API void set_ReadTimeout (int timeout)
 Sets a value that determines whether the current stream can time out. More...
 
virtual ASPOSECPP_SHARED_API int get_ReadTimeout () const
 
virtual ASPOSECPP_SHARED_API 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 ASPOSECPP_SHARED_API 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
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 reference 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 int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () 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 (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. 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

 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)
 
virtual int64_t Pubseekpos (int64_t value)=0
 
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)
 
void DecodeElem (int_type meta, ArrayPtr< uint8_t > &destination)
 
char_type EncodeElem ()
 
char_type EncodeElem (uint8_t *source)
 
void EncodeElem (uint8_t *source, char_type *destination)
 
- Protected Member Functions inherited from System::IO::Stream
virtual ASPOSECPP_SHARED_API void Dispose (bool disposing)
 

Protected Attributes

std::basic_ios< char_type, traits_type > & m_stream
 Reference to the stream. More...
 
const STDIOStreamWrappingMode m_wrapping_mode
 Wrapping mode. More...
 
const bool m_can_read
 CanRead flag. More...
 
const bool m_can_write
 CanWrite flag. More...
 
const bool m_can_seek
 CanSeek flag. More...
 
int64_t m_last_elem_gpos
 Last read position. More...
 
int64_t m_last_elem_ppos
 Last write position. More...
 
int64_t m_elem_pos
 Read/write position. More...
 
int64_t m_byte_pos
 Read/write position in bytes. More...
 
int64_t m_length
 Stream's length. More...
 
ArrayPtr< uint8_t > m_decoded_elem
 The last decoded element storage. More...
 

Static Protected Attributes

static constexpr uint8_t m_elem_size = sizeof(char_type)
 char_type size = sizeof(char_type). 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...
 
- Static Public Attributes inherited from System::IO::Stream
static const System::SharedPtr< Stream > ASPOSECPP_SHARED_API Null
 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::BasicSTDIOStreamWrapper< T, typename >, System::IO::BasicSTDOStreamWrapper< T, typename >, System::IO::BasicSTDOStreamWrapper< T >, System::IO::BasicSTDIStreamWrapper< T, typename >, and System::IO::BasicSTDIStreamWrapper< T >.

◆ 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

Member Data Documentation

◆ m_byte_pos

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

Read/write position in bytes.

◆ m_can_read

template<typename T, typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
const bool System::IO::STDIOStreamWrapperBase< T, typename >::m_can_read
protected

CanRead flag.

◆ m_can_seek

template<typename T, typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
const bool System::IO::STDIOStreamWrapperBase< T, typename >::m_can_seek
protected

CanSeek flag.

◆ m_can_write

template<typename T, typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
const bool System::IO::STDIOStreamWrapperBase< T, typename >::m_can_write
protected

CanWrite flag.

◆ m_decoded_elem

template<typename T, typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
ArrayPtr<uint8_t> System::IO::STDIOStreamWrapperBase< T, typename >::m_decoded_elem
protected

The last decoded element storage.

◆ m_elem_pos

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

Read/write position.

◆ m_elem_size

template<typename T, typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
constexpr uint8_t System::IO::STDIOStreamWrapperBase< T, typename >::m_elem_size = sizeof(char_type)
staticprotected

char_type size = sizeof(char_type).

◆ m_last_elem_gpos

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

Last read position.

◆ m_last_elem_ppos

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

Last write position.

◆ m_length

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

Stream's length.

◆ m_stream

template<typename T, typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
std::basic_ios<char_type, traits_type>& System::IO::STDIOStreamWrapperBase< T, typename >::m_stream
protected

Reference to the stream.

◆ m_wrapping_mode

template<typename T, typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ios, T>::value>>
const STDIOStreamWrappingMode System::IO::STDIOStreamWrapperBase< T, typename >::m_wrapping_mode
protected

Wrapping mode.