Represents a stream that reads from and writes to memory. 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...

#include <memory_stream.h>

Inherits System::IO::Stream.

Public Types
typedef System::SharedPtr< System::IO::MemoryStream >	Ptr
	An alias for a shared pointer to the self. More...

Public Types inherited from System::IO::Stream
typedef SharedPtr< Stream >	Ptr
	An alias for a shared pointer to this class. More...

Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

Public Member Functions
	MemoryStream ()
	Constructs a new instance of the MemoryStream class with initial capacity equal to 0. More...

	MemoryStream (int capacity_)
	Constructs a new instance of the MemoryStream class that represents a stream based on a memory buffer of the specified size. More...

	MemoryStream (const ArrayPtr< uint8_t > &content, bool writable=true)
	Constructs a new instance of the MemoryStream class that represents a memory stream which is connected to the specified memory buffer. A parameter specifies if the stream is writable. More...

	MemoryStream (const ArrayPtr< uint8_t > &content, int index, int count, bool writable=true, bool publiclyVisible=false)
	Constructs a new instance of the MemoryStream class that represents a memory stream which is connected to a segment of the specified memory buffer starting at the specified index and including the specified number of elements. Parameters specifies if the stream is writable and if method GetBytes() can be called. More...

void	set_Capacity (int value)
	Sets the capacity of the underlying memory buffer. More...

int	get_Capacity ()
	Returns the current capacity of the underlying memory buffer. More...

virtual ArrayPtr< uint8_t >	ToArray ()
	Returns a copy of underlying memory buffer as an array of bytes. More...

int	ReadByte () override
	Reads a single byte from the stream and returns a 32-bit integer value equivalent to the value of the read byte. More...

void	WriteByte (uint8_t value) override
	Writes the specified unsigned 8-bit integer value to the stream. More...

int32_t	Read (const ArrayPtr< uint8_t > &buffer, int32_t offset, int32_t count) override
	Reads the specified number of bytes from the stream and writes them to the specified byte array. More...

void	Write (const ArrayPtr< uint8_t > &buffer, int32_t offset, int32_t count) override
	Writes the specified subrange of bytes from the specified byte array to the stream. More...

int32_t	Read (const System::Details::ArrayView< uint8_t > &buffer, int32_t offset, int32_t count) override
	Reads the specified number of bytes from the stream and writes them to the specified byte array. More...

void	Write (const System::Details::ArrayView< uint8_t > &buffer, int32_t offset, int32_t count) override
	Writes the specified subrange of bytes from the specified byte array to the stream. More...

int64_t	Seek (int64_t offset, SeekOrigin origin) override
	Sets the position of the stream represented by the current object. More...

void	SetLength (int64_t value) override
	Sets the length of the stream represented by the current object. More...

void	Flush () override
	Does nothing. More...

virtual void	WriteTo (SharedPtr< Stream > stream)
	Writes the content of the underlying buffer to the specified stream. More...

virtual ArrayPtr< uint8_t >	GetBuffer ()
	Returns a pointer to the underlying buffer. More...

bool	TryGetBuffer (ArraySegment< uint8_t > &buffer)
	Returns the array of unsigned bytes from which this stream was created. More...

void	set_Position (int64_t value) override
	Sets the stream's position. More...

int64_t	get_Position () const override
	Returns the current position of the stream. More...

int64_t	get_Length () const override
	Returns the length of the stream in bytes. More...

bool	get_CanRead () const override
	Determines if the stream is readable. More...

bool	get_CanSeek () const override
	Determines if the stream supports seeking. More...

bool	get_CanWrite () const override
	Determines if the stream is writable. More...

virtual void	Close () override
	Closes the stream. 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 int64_t	Seek (int64_t offset, SeekOrigin origin)=0
	Sets the position of the stream represented by the current object. 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::IAsyncResult >	BeginRead (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::IAsyncResult >	BeginWrite (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 void	set_Position (int64_t value)=0
	Sets the stream's position. More...

virtual int64_t	get_Position () const =0
	Returns the current position of the stream. More...

virtual int64_t	get_Length () const =0
	Returns the length of the stream in bytes. More...

virtual bool	get_CanRead () const =0
	Determines if the stream is readable. More...

virtual bool	get_CanSeek () const =0
	Determines if the stream supports seeking. More...

virtual bool	get_CanWrite () const =0
	Determines if the stream is writable. 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...

virtual void	Dispose ()
	Does nothing. 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...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	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 TypeInfo &	GetType () 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...

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 TypeInfo &	Type ()
	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 >	Null
	A stream with no underlying storage. 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...

Detailed Description

Represents a stream that reads from and writes to memory. 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

◆ Ptr

typedef System::SharedPtr<System::IO::MemoryStream> System::IO::MemoryStream::Ptr

An alias for a shared pointer to the self.

Constructor & Destructor Documentation

◆ MemoryStream() [1/4]

System::IO::MemoryStream::MemoryStream ( )

Constructs a new instance of the MemoryStream class with initial capacity equal to 0.

◆ MemoryStream() [2/4]

System::IO::MemoryStream::MemoryStream ( int capacity_ )

Constructs a new instance of the MemoryStream class that represents a stream based on a memory buffer of the specified size.

Parameters

capacity_ The size in bytes of a memory buffer associated with the stream represented by the object being created

◆ MemoryStream() [3/4]

System::IO::MemoryStream::MemoryStream	(	const ArrayPtr< uint8_t > &	content,
		bool	writable = `true`
	)

Constructs a new instance of the MemoryStream class that represents a memory stream which is connected to the specified memory buffer. A parameter specifies if the stream is writable.

Parameters

content	A byte array to be used as a memory buffer on which the stream represented by the object being created will be based
writable	Specifies if the stream should be writable

◆ MemoryStream() [4/4]

System::IO::MemoryStream::MemoryStream	(	const ArrayPtr< uint8_t > &	content,
		int	index,
		int	count,
		bool	writable = `true`,
		bool	publiclyVisible = `false`
	)

Constructs a new instance of the MemoryStream class that represents a memory stream which is connected to a segment of the specified memory buffer starting at the specified index and including the specified number of elements. Parameters specifies if the stream is writable and if method GetBytes() can be called.

Parameters

content	A byte array a segment of which is to be used as a memory buffer on which the stream represented by the object being created will be based
index	A 0-based index of the element in `content` at which the segment begins
count	The number of elements of `content` included in the segment
writable	Specifies if the stream should be writable
publiclyVisible	Specifies if the underlying memory buffer should be made available to the caller of method GetByte()

Member Function Documentation

◆ Close()

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

overridevirtual

Closes the stream.

Reimplemented from System::IO::Stream.

◆ Flush()

void System::IO::MemoryStream::Flush ( )

overridevirtual

Does nothing.

Implements System::IO::Stream.

◆ get_CanRead()

bool System::IO::MemoryStream::get_CanRead ( ) const

overridevirtual

Determines if the stream is readable.

Returns: True if the stream is readable; otherwise - false

Implements System::IO::Stream.

◆ get_CanSeek()

bool System::IO::MemoryStream::get_CanSeek ( ) const

overridevirtual

Determines if the stream supports seeking.

Returns: True if the stream supports seeking; otherwise - false

Implements System::IO::Stream.

◆ get_CanWrite()

bool System::IO::MemoryStream::get_CanWrite ( ) const

overridevirtual

Determines if the stream is writable.

Returns: True if the stream is writable; otherwise - false

Implements System::IO::Stream.

◆ get_Capacity()

int System::IO::MemoryStream::get_Capacity ( )

Returns the current capacity of the underlying memory buffer.

◆ get_Length()

int64_t System::IO::MemoryStream::get_Length ( ) const

overridevirtual

Returns the length of the stream in bytes.

Implements System::IO::Stream.

◆ get_Position()

int64_t System::IO::MemoryStream::get_Position ( ) const

overridevirtual

Returns the current position of the stream.

Implements System::IO::Stream.

◆ GetBuffer()

virtual ArrayPtr< uint8_t > System::IO::MemoryStream::GetBuffer ( )

virtual

Returns a pointer to the underlying buffer.

◆ Read() [1/2]

int32_t System::IO::MemoryStream::Read	(	const ArrayPtr< uint8_t > &	buffer,
		int32_t	offset,
		int32_t	count
	)

overridevirtual

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

Parameters

buffer	The byte array to write the read bytes to
offset	A 0-based position in `buffer` to start writing at
count	The number of bytes to read

Returns: The number of bytes read

Implements System::IO::Stream.

◆ Read() [2/2]

int32_t System::IO::MemoryStream::Read	(	const System::Details::ArrayView< uint8_t > &	buffer,
		int32_t	offset,
		int32_t	count
	)

overridevirtual

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

Parameters

buffer	The byte array view to write the read bytes to
offset	A 0-based position in `buffer` to start writing at
count	The number of bytes to read

Returns: The number of bytes read

Reimplemented from System::IO::Stream.

◆ ReadByte()

int System::IO::MemoryStream::ReadByte ( )

overridevirtual

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

Reimplemented from System::IO::Stream.

◆ Seek()

int64_t System::IO::MemoryStream::Seek	(	int64_t	offset,
		SeekOrigin	origin
	)

overridevirtual

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

Parameters

offset	The byte offset relative to a position specified by `origin`
origin	Specifies 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_Capacity()

void System::IO::MemoryStream::set_Capacity ( int value )

Sets the capacity of the underlying memory buffer.

Parameters

value The new capacity in bytes to set

◆ set_Position()

void System::IO::MemoryStream::set_Position ( int64_t value )

overridevirtual

Sets the stream's position.

Parameters

value The byte offset to set the stream's position to

Implements System::IO::Stream.

◆ SetLength()

void System::IO::MemoryStream::SetLength ( int64_t value )

overridevirtual

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

Parameters

value The length in bytes to set

Implements System::IO::Stream.

◆ ToArray()

virtual ArrayPtr< uint8_t > System::IO::MemoryStream::ToArray ( )

virtual

Returns a copy of underlying memory buffer as an array of bytes.

◆ TryGetBuffer()

bool System::IO::MemoryStream::TryGetBuffer ( ArraySegment< uint8_t > & buffer )

Returns the array of unsigned bytes from which this stream was created.

Parameters

buffer byte array - out paramter. When this method returns true, the byte array segment from which this stream was created; when this method returns false, this parameter is set to default.

Returns: True if the conversion succeeded.

◆ Write() [1/2]

void System::IO::MemoryStream::Write	(	const ArrayPtr< uint8_t > &	buffer,
		int32_t	offset,
		int32_t	count
	)

overridevirtual

Writes the specified subrange of bytes from the specified byte array to the stream.

Parameters

buffer	The array containing the bytes to write
offset	A 0-based index of the elemnet in `buffer` at which the subrange to write begins
count	The number of elements in the subrange to write

Implements System::IO::Stream.

◆ Write() [2/2]

void System::IO::MemoryStream::Write	(	const System::Details::ArrayView< uint8_t > &	buffer,
		int32_t	offset,
		int32_t	count
	)

overridevirtual

Writes the specified subrange of bytes from the specified byte array to the stream.

Parameters

buffer	The array view containing the bytes to write
offset	A 0-based index of the elemnet in `buffer` at which the subrange to write begins
count	The number of elements in the subrange to write

Reimplemented from System::IO::Stream.

◆ WriteByte()

void System::IO::MemoryStream::WriteByte ( uint8_t value )

overridevirtual

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

Parameters

value The value to write

Reimplemented from System::IO::Stream.

◆ WriteTo()

virtual void System::IO::MemoryStream::WriteTo ( SharedPtr< Stream > stream )

virtual

Writes the content of the underlying buffer to the specified stream.

Parameters

stream The stream to write to

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ MemoryStream() [1/4]

◆ MemoryStream() [2/4]

◆ MemoryStream() [3/4]

◆ MemoryStream() [4/4]

Member Function Documentation

◆ Close()

◆ Flush()

◆ get_CanRead()

◆ get_CanSeek()

◆ get_CanWrite()

◆ get_Capacity()

◆ get_Length()

◆ get_Position()

◆ GetBuffer()

◆ Read() [1/2]

◆ Read() [2/2]

◆ ReadByte()

◆ Seek()

◆ set_Capacity()

◆ set_Position()

◆ SetLength()

◆ ToArray()

◆ TryGetBuffer()

◆ Write() [1/2]

◆ Write() [2/2]

◆ WriteByte()

◆ WriteTo()