Asposecpplib
System::IO::BasicSTDOStreamWrapper< T, typename > Class Template Reference

Represents a System.IO.Stream-like wrapper for std::basic_ostream and its derived objects. 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::STDIOStreamWrapperBase< T, typename >.

Inherited by System::IO::BasicSTDIOStreamWrapper< T, typename >.

Public Types

using ThisType = BasicSTDOStreamWrapper< T >
 
using BaseType = STDIOStreamWrapperBase< T >
 
using ThisTypeBaseTypesInfo = BaseTypesInfo< BaseType >
 
using char_type = typename BaseType::char_type
 
using traits_type = typename BaseType::traits_type
 
- Public Types inherited from System::IO::STDIOStreamWrapperBase< T, typename >
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...
 
 BasicSTDOStreamWrapper (std::basic_ostream< char_type, traits_type > &str, STDIOStreamWrappingMode mode=STDIOStreamWrappingMode::Binary)
 Constructs a new instance of the BasicSTDOStreamWrapper. More...
 
 BasicSTDOStreamWrapper (const BasicSTDOStreamWrapper &)=delete
 Copy constructor. Deleted. More...
 
BasicSTDOStreamWrapperoperator= (const BasicSTDOStreamWrapper &)=delete
 Copy assignment operator. Deleted. More...
 
virtual int ReadByte () override
 If wrapping mode is binary, reads a single byte from the last decoded character storage, otherwise read a single character from the stream and convert it to uint8_t type. Not supported! More...
 
virtual void WriteByte (uint8_t value) override
 If wrapping mode is binary, writes to the stream the specified unsigned 8-bit integer value, otherwise convert it to char_type type and then write the result to the stream. More...
 
virtual int Read (ArrayPtr< uint8_t > buffer, int offset, int count) override
 If wrapping mode is binary, reads the specified number of bytes from the stream, otherwise read the specified number of characters and converts them to uint8_t type. Writes result of the reading to the specified byte array. Not supported! More...
 
virtual void Write (ArrayPtr< uint8_t > buffer, int offset, int count) override
 If wrapping mode is binary, writes to the stream the specified subrange of bytes from the specified byte array, otherwise convert the specified subrange of bytes from the specified byte array to char_type type ant then writes result to the stream. More...
 
virtual void SetLength (int64_t value) override
 Sets the length of the stream represented by the current object. More...
 
virtual void Flush () override
 Clears this stream's buffers and writes all buffered data to the underlying storage. More...
 
- Public Member Functions inherited from System::IO::STDIOStreamWrapperBase< T, typename >
 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 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)
 Initiates an asynchronous read operation. More...
 
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)
 Initiates an asynchronous write operation. More...
 
virtual ASPOSECPP_SHARED_API int EndRead (System::SharedPtr< System::IAsyncResult > asyncResult)
 Waits until the specified asynchronous read operation completes. More...
 
virtual ASPOSECPP_SHARED_API void EndWrite (System::SharedPtr< System::IAsyncResult > asyncResult)
 Ends an asynchronous write operation. Waits until the specified asynchronous write operation completes. More...
 
ASPOSECPP_SHARED_API void CopyTo (const SharedPtr< Stream > &destination)
 Copies bytes to the specified stream. More...
 
ASPOSECPP_SHARED_API void CopyTo (const SharedPtr< Stream > &destination, int32_t buffer_size)
 Copies bytes to the specified stream, using the specified buffer size. More...
 
virtual ASPOSECPP_SHARED_API bool get_CanTimeout () const
 Gets a value that determines whether the current stream can time out. More...
 
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
 Gets a value, in milliseconds, that determines how long the stream will attempt to read before timing out. More...
 
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 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

virtual int64_t Pubseekpos (int64_t value) override
 Seeks positions of read or write or both on value. More...
 
virtual void Check () const override
 Check if the stream has been modified outside the wrapper. More...
 
virtual void Sync () override
 Syncronize write position. More...
 
virtual ASPOSECPP_SHARED_API bool get_CanWrite () const=0
 Determines if the stream is writable. More...
 
- Protected Member Functions inherited from 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)
 Constructs a new instance of the STDIOStreamWrapperBase. 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 ASPOSECPP_SHARED_API void Dispose (bool disposing)
 Releases all resources used by the current object and closes the stream. More...
 
virtual ASPOSECPP_SHARED_API int32_t ReadImpl (const ArrayPtr< uint8_t > &buffer, int32_t offset, int32_t count)
 Reads the specified number of bytes from the stream and writes them to the specified buffer. 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< Stream > ASPOSECPP_SHARED_API Null
 A stream with no underlying storage. More...
 
- Protected Attributes inherited from System::IO::STDIOStreamWrapperBase< T, typename >
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 inherited from System::IO::STDIOStreamWrapperBase< T, typename >
static constexpr uint8_t m_elem_size = sizeof(char_type)
 char_type size = sizeof(char_type). More...
 

Detailed Description

template<typename T, typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ostream, T>::value>>
class System::IO::BasicSTDOStreamWrapper< T, typename >

Represents a System.IO.Stream-like wrapper for std::basic_ostream and its derived objects. 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_ostream, T>::value>>
using System::IO::BasicSTDOStreamWrapper< T, typename >::BaseType = STDIOStreamWrapperBase<T>

◆ char_type

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ostream, T>::value>>
using System::IO::BasicSTDOStreamWrapper< T, typename >::char_type = typename BaseType::char_type

◆ ThisType

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

◆ ThisTypeBaseTypesInfo

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

◆ traits_type

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ostream, T>::value>>
using System::IO::BasicSTDOStreamWrapper< T, typename >::traits_type = typename BaseType::traits_type

Constructor & Destructor Documentation

◆ BasicSTDOStreamWrapper() [1/2]

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ostream, T>::value>>
System::IO::BasicSTDOStreamWrapper< T, typename >::BasicSTDOStreamWrapper ( std::basic_ostream< char_type, traits_type > &  str,
STDIOStreamWrappingMode  mode = STDIOStreamWrappingMode::Binary 
)
inline

Constructs a new instance of the BasicSTDOStreamWrapper.

Parameters
strThe reference to the stream
modeWrapping mode

◆ BasicSTDOStreamWrapper() [2/2]

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

Copy constructor. Deleted.

Member Function Documentation

◆ Check()

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ostream, T>::value>>
virtual void System::IO::BasicSTDOStreamWrapper< T, typename >::Check ( ) const
inlineoverrideprotectedvirtual

Check if the stream has been modified outside the wrapper.

Reimplemented from System::IO::STDIOStreamWrapperBase< T, typename >.

Reimplemented in System::IO::BasicSTDIOStreamWrapper< T, typename >.

◆ Flush()

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ostream, T>::value>>
virtual void System::IO::BasicSTDOStreamWrapper< T, typename >::Flush ( )
inlineoverridevirtual

Clears this stream's buffers and writes all buffered data to the underlying storage.

Implements System::IO::Stream.

Reimplemented in System::IO::BasicSTDIOStreamWrapper< T, typename >.

◆ get_CanWrite()

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ostream, T>::value>>
virtual ASPOSECPP_SHARED_API bool System::IO::Stream::get_CanWrite
protected

Determines if the stream is writable.

Returns
True if the stream is writable; otherwise - false

◆ operator=()

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

Copy assignment operator. Deleted.

◆ Pubseekpos()

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ostream, T>::value>>
virtual int64_t System::IO::BasicSTDOStreamWrapper< T, typename >::Pubseekpos ( int64_t  value)
inlineoverrideprotectedvirtual

Seeks positions of read or write or both on value.

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

Implements System::IO::STDIOStreamWrapperBase< T, typename >.

Reimplemented in System::IO::BasicSTDIOStreamWrapper< T, typename >.

◆ Read()

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ostream, T>::value>>
virtual int System::IO::BasicSTDOStreamWrapper< T, typename >::Read ( ArrayPtr< uint8_t >  buffer,
int  offset,
int  count 
)
inlineoverridevirtual

If wrapping mode is binary, reads the specified number of bytes from the stream, otherwise read the specified number of characters and converts them to uint8_t type. Writes result of the reading to the specified byte array. Not supported!

Parameters
bufferThe byte array to write the read bytes to
offsetA 0-based position in buffer to start writing at
countThe number of bytes to read
Returns
Number of bytes or characters read

Implements System::IO::Stream.

Reimplemented in System::IO::BasicSTDIOStreamWrapper< T, typename >.

◆ ReadByte()

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ostream, T>::value>>
virtual int System::IO::BasicSTDOStreamWrapper< T, typename >::ReadByte ( )
inlineoverridevirtual

If wrapping mode is binary, reads a single byte from the last decoded character storage, otherwise read a single character from the stream and convert it to uint8_t type. Not supported!

Returns
A 32-bit integer value equivalent to the result of reading

Reimplemented from System::IO::Stream.

Reimplemented in System::IO::BasicSTDIOStreamWrapper< T, typename >.

◆ RTTI_INFO_TEMPLATE_CLASS()

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

RTTI information.

◆ SetLength()

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ostream, T>::value>>
virtual void System::IO::BasicSTDOStreamWrapper< T, typename >::SetLength ( int64_t  value)
inlineoverridevirtual

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

Parameters
valueThe length in bytes to set

Implements System::IO::Stream.

Reimplemented in System::IO::BasicSTDIOStreamWrapper< T, typename >.

◆ Sync()

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ostream, T>::value>>
virtual void System::IO::BasicSTDOStreamWrapper< T, typename >::Sync ( )
inlineoverrideprotectedvirtual

◆ Write()

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ostream, T>::value>>
virtual void System::IO::BasicSTDOStreamWrapper< T, typename >::Write ( ArrayPtr< uint8_t >  buffer,
int  offset,
int  count 
)
inlineoverridevirtual

If wrapping mode is binary, writes to the stream the specified subrange of bytes from the specified byte array, otherwise convert the specified subrange of bytes from the specified byte array to char_type type ant then writes result to the stream.

Parameters
bufferThe array containing the bytes to write
offsetA 0-based index of the elemnet in buffer at which the subrange to write begins
countThe number of elements in the subrange to write

Implements System::IO::Stream.

Reimplemented in System::IO::BasicSTDIOStreamWrapper< T, typename >.

◆ WriteByte()

template<typename T , typename = std::enable_if_t<IsTemplateBaseOf<std::basic_ostream, T>::value>>
virtual void System::IO::BasicSTDOStreamWrapper< T, typename >::WriteByte ( uint8_t  value)
inlineoverridevirtual

If wrapping mode is binary, writes to the stream the specified unsigned 8-bit integer value, otherwise convert it to char_type type and then write the result to the stream.

Parameters
valueThe value to write

Reimplemented from System::IO::Stream.

Reimplemented in System::IO::BasicSTDIOStreamWrapper< T, typename >.