A base class for a variety of stream implementations. More...

Inherits System::IDisposable.

Inherited by Aspose::Zip::CrcCalculatorStream, Aspose::Zip::ZlibBaseStream, System::IO::BufferedStream, System::IO::FileStream, System::IO::MemoryStream, System::IO::UnmanagedMemoryStream, and System::Security::Cryptography::CryptoStream.

Public Types

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

virtual int ReadByte ()
 
virtual void WriteByte (uint8_t value)
 
virtual int Read (ArrayPtr< uint8_t > buffer, int offset, int count)=0
 
virtual void Write (ArrayPtr< uint8_t > buffer, int offset, int count)=0
 
virtual int64_t Seek (int64_t offset, SeekOrigin origin)=0
 
virtual void SetLength (int64_t value)=0
 
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...
 
virtual 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)
 
virtual System::SharedPtr< System::IAsyncResultBeginWrite (System::ArrayPtr< uint8_t > buffer, int offset, int count, System::AsyncCallback callback, System::SharedPtr< System::Object > state)
 
virtual int EndRead (System::SharedPtr< System::IAsyncResult > asyncResult)
 
virtual void EndWrite (System::SharedPtr< System::IAsyncResult > asyncResult)
 
virtual void set_Position (int64_t value)=0
 
virtual int64_t get_Position () ASPOSE_CONST=0
 Returns the current position of the stream. More...
 
virtual int64_t get_Length () ASPOSE_CONST=0
 Returns the length of the stream in bytes. More...
 
virtual bool get_CanRead () ASPOSE_CONST=0
 
virtual bool get_CanSeek () ASPOSE_CONST=0
 
virtual bool get_CanWrite () ASPOSE_CONST=0
 
- 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)
 

Static Public Attributes

static const System::SharedPtr< Stream > ASPOSECPP_SHARED_API Null
 A stream with no underlying storage. More...
 

Protected Member Functions

virtual void Dispose (bool disposing)
 
- 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

- 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

A base class for a variety of stream implementations.

Member Typedef Documentation

◆ Ptr

An alias for a shared pointer to this class.

Member Function Documentation

◆ BeginRead()

virtual System::SharedPtr<System::IAsyncResult> System::IO::Stream::BeginRead ( System::ArrayPtr< uint8_t >  buffer,
int  offset,
int  count,
System::AsyncCallback  callback,
System::SharedPtr< System::Object state 
)
virtual

Initiates an asynchronous read operation.

Parameters
bufferA buffer to read to
offsetA 0-based offset in buffer indicating the position from which to start writing the read data
countThe number of bytes to read
callbackA callback to be called when the operation completes
stateUser-provided data used to uniquly identify each particular asynchronous read operation
Returns
An IAsyncResult object representing the initiated asynchronous read operation

◆ BeginWrite()

virtual System::SharedPtr<System::IAsyncResult> System::IO::Stream::BeginWrite ( System::ArrayPtr< uint8_t >  buffer,
int  offset,
int  count,
System::AsyncCallback  callback,
System::SharedPtr< System::Object state 
)
virtual

Initiates an asynchronous write operation.

Parameters
bufferA buffer containing data to be written
offsetA 0-based offset in buffer indicating the position from which the data to write begins
countThe number of bytes to write
callbackA callback to be called when the operation completes
stateUser-provided data used to uniquly identify each particular asynchronous write operation
Returns
An IAsyncResult object representing the initiated asynchronous write operation

◆ Close()

virtual void System::IO::Stream::Close ( )
inlinevirtual

◆ Dispose() [1/2]

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

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

Reimplemented from System::IDisposable.

◆ Dispose() [2/2]

virtual void System::IO::Stream::Dispose ( bool  disposing)
protectedvirtual

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

Parameters
disposingSpecifies whether the stream should be closed.

Reimplemented in System::IO::UnmanagedMemoryStream.

◆ EndRead()

virtual int System::IO::Stream::EndRead ( System::SharedPtr< System::IAsyncResult asyncResult)
virtual

Waits until the specified asynchronous read operation completes.

Parameters
asyncResultAn IAsyncResult object that represents an asynchronous read operation
Returns
The number of bytes read during the read operation represented by asyncResult

◆ EndWrite()

virtual void System::IO::Stream::EndWrite ( System::SharedPtr< System::IAsyncResult asyncResult)
virtual

Ends an asynchronous write operation. Waits until the specified asynchronous write operation completes.

Parameters
asyncResultAn IAsyncResult object that represents an asynchronous write operation

◆ Flush()

virtual void System::IO::Stream::Flush ( )
pure virtual

◆ get_CanRead()

virtual bool System::IO::Stream::get_CanRead ( )
pure virtual

◆ get_CanSeek()

virtual bool System::IO::Stream::get_CanSeek ( )
pure virtual

◆ get_CanWrite()

virtual bool System::IO::Stream::get_CanWrite ( )
pure virtual

◆ get_Length()

virtual int64_t System::IO::Stream::get_Length ( )
pure virtual

◆ get_Position()

virtual int64_t System::IO::Stream::get_Position ( )
pure virtual

◆ Read()

virtual int System::IO::Stream::Read ( ArrayPtr< uint8_t >  buffer,
int  offset,
int  count 
)
pure virtual

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

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
The number of bytes read

Implemented in System::IO::FileStream, System::IO::MemoryStream, Aspose::Zip::CrcCalculatorStream, System::IO::BufferedStream, and System::Security::Cryptography::CryptoStream.

◆ ReadByte()

virtual int System::IO::Stream::ReadByte ( )
virtual

Reads a single byte from the stream and returns a 32-bit integer value equivalent to the value of the read byte.

Reimplemented in System::IO::FileStream, System::IO::MemoryStream, and System::IO::BufferedStream.

◆ Seek()

virtual int64_t System::IO::Stream::Seek ( int64_t  offset,
SeekOrigin  origin 
)
pure virtual

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

Implemented in System::IO::UnmanagedMemoryStream, System::IO::FileStream, System::IO::MemoryStream, Aspose::Zip::ZlibBaseStream, Aspose::Zip::CrcCalculatorStream, System::IO::BufferedStream, and System::Security::Cryptography::CryptoStream.

◆ set_Position()

virtual void System::IO::Stream::set_Position ( int64_t  value)
pure virtual

◆ SetLength()

virtual void System::IO::Stream::SetLength ( int64_t  value)
pure virtual

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

Parameters
valueThe length in bytes to set

Implemented in System::IO::UnmanagedMemoryStream, System::IO::FileStream, System::IO::MemoryStream, Aspose::Zip::ZlibBaseStream, Aspose::Zip::CrcCalculatorStream, System::IO::BufferedStream, and System::Security::Cryptography::CryptoStream.

◆ Write()

virtual void System::IO::Stream::Write ( ArrayPtr< uint8_t >  buffer,
int  offset,
int  count 
)
pure virtual

Writes the specified subrange of bytes from the specified byte array 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

Implemented in System::IO::FileStream, System::IO::MemoryStream, Aspose::Zip::CrcCalculatorStream, System::IO::BufferedStream, and System::Security::Cryptography::CryptoStream.

◆ WriteByte()

virtual void System::IO::Stream::WriteByte ( uint8_t  value)
virtual

Writes the specified unsigned 8-bit integer value to the stream.

Parameters
valueThe value to write

Reimplemented in System::IO::FileStream, System::IO::MemoryStream, and System::IO::BufferedStream.

Member Data Documentation

◆ Null

const System::SharedPtr<Stream> ASPOSECPP_SHARED_API System::IO::Stream::Null
static

A stream with no underlying storage.