A base class for a variety of stream implementations. 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 <stream.h>

Inherits System::IDisposable.

Inherited by Aspose::Brotli::BrotliStream, Aspose::Zip::CrcCalculatorStream, Aspose::Zip::ZlibBaseStream, System::IO::BufferedStream, System::IO::FileStream, System::IO::MemoryStream, System::IO::STDIOStreamWrapperBase< T, typename >, System::IO::UnmanagedMemoryStream, System::Net::Security::AuthenticatedStream, System::Net::Sockets::NetworkStream, and System::Security::Cryptography::CryptoStream.

Public Types
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
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 RTaskPtr< int32_t >	ReadAsync (const ArrayPtr< uint8_t > &buffer, int32_t offset, int32_t count, const Threading::CancellationToken &cancellationToken)
	Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests. More...

RTaskPtr< int32_t >	ReadAsync (const ArrayPtr< uint8_t > &buffer, int32_t offset, int32_t count)
	Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests. 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 TaskPtr	WriteAsync (const ArrayPtr< uint8_t > &buffer, int32_t offset, int32_t count, const Threading::CancellationToken &cancellationToken)
	Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests. More...

TaskPtr	WriteAsync (const ArrayPtr< uint8_t > &buffer, int32_t offset, int32_t count)
	Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests. 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 TaskPtr	FlushAsync (const Threading::CancellationToken &cancellationToken)
	Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests. More...

TaskPtr	FlushAsync ()
	Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests. 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...

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

Protected Member Functions
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 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...

Detailed Description

A base class for a variety of stream implementations. 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 SharedPtr<Stream> System::IO::Stream::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

buffer	A buffer to read to
offset	A 0-based offset in `buffer` indicating the position from which to start writing the read data
count	The number of bytes to read
callback	A callback to be called when the operation completes
state	User-provided data used to uniquely identify each 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

buffer	A buffer containing data to be written
offset	A 0-based offset in `buffer` indicating the position from which the data to write begins
count	The number of bytes to write
callback	A callback to be called when the operation completes
state	User-provided data used to uniquely identify each asynchronous write operation

Returns: An IAsyncResult object representing the initiated asynchronous write operation

◆ Close()

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

inlinevirtual

Closes the stream.

Reimplemented in System::Net::Security::SslStream, System::Security::Cryptography::CryptoStream, System::IO::FileStream, and System::IO::MemoryStream.

◆ CopyTo() [1/2]

void System::IO::Stream::CopyTo ( const SharedPtr< Stream > & destination )

Copies bytes to the specified stream.

Parameters

destination Stream to which data will be copied.

◆ CopyTo() [2/2]

void System::IO::Stream::CopyTo	(	const SharedPtr< Stream > &	destination,
		int32_t	buffer_size
	)

Copies bytes to the specified stream, using the specified buffer size.

Parameters

destination	Stream to which data will be copied.
buffer_size	Size of the buffer.

◆ Dispose() [1/2]

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

disposing Specifies whether the stream should be closed.

Reimplemented in System::Net::Security::SslStream, and 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

asyncResult An 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

asyncResult An IAsyncResult object that represents an asynchronous write operation

◆ Flush()

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

pure virtual

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

Implemented in System::Net::Security::SslStream, System::Net::Sockets::NetworkStream, System::Security::Cryptography::CryptoStream, System::IO::BufferedStream, System::IO::FileStream, System::IO::MemoryStream, System::IO::BasicSTDIStreamWrapper< T, typename >, System::IO::BasicSTDOStreamWrapper< T, typename >, System::IO::BasicSTDIOStreamWrapper< T, typename >, and System::IO::UnmanagedMemoryStream.

◆ FlushAsync() [1/2]

TaskPtr System::IO::Stream::FlushAsync ( )

Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.

Returns: A task that represents the asynchronous flush operation.

◆ FlushAsync() [2/2]

virtual TaskPtr System::IO::Stream::FlushAsync ( const Threading::CancellationToken & cancellationToken )

virtual

Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.

Parameters

cancellationToken The token to monitor for cancellation requests.

Returns: A task that represents the asynchronous flush operation.

Reimplemented in System::IO::FileStream.

◆ get_CanRead()

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

pure virtual

Determines if the stream is readable.

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

Implemented in System::Net::Security::SslStream, System::Net::Sockets::NetworkStream, System::Security::Cryptography::CryptoStream, System::IO::BufferedStream, System::IO::FileStream, System::IO::MemoryStream, System::IO::STDIOStreamWrapperBase< T, typename >, System::IO::UnmanagedMemoryStream, and System::IO::BasicSTDIStreamWrapper< T, typename >.

◆ get_CanSeek()

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

pure virtual

Determines if the stream supports seeking.

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

Implemented in System::Net::Security::SslStream, System::Net::Sockets::NetworkStream, System::Security::Cryptography::CryptoStream, System::IO::BufferedStream, System::IO::FileStream, System::IO::MemoryStream, System::IO::STDIOStreamWrapperBase< T, typename >, and System::IO::UnmanagedMemoryStream.

◆ get_CanTimeout()

virtual bool System::IO::Stream::get_CanTimeout ( ) const

virtual

Gets a value that determines whether the current stream can time out.

Returns: True when the current stream can time out, otherwise - false.

Reimplemented in System::Net::Security::SslStream, and System::Net::Sockets::NetworkStream.

◆ get_CanWrite()

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

pure virtual

Determines if the stream is writable.

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

Implemented in System::Net::Security::SslStream, System::Net::Sockets::NetworkStream, System::Security::Cryptography::CryptoStream, System::IO::BufferedStream, System::IO::FileStream, System::IO::MemoryStream, System::IO::STDIOStreamWrapperBase< T, typename >, System::IO::UnmanagedMemoryStream, and System::IO::BasicSTDOStreamWrapper< T, typename >.

◆ get_Length()

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

pure virtual

Returns the length of the stream in bytes.

Returns: The length of the stream in bytes.

Implemented in System::Net::Security::SslStream, System::Net::Sockets::NetworkStream, System::Security::Cryptography::CryptoStream, System::IO::BufferedStream, System::IO::FileStream, System::IO::MemoryStream, System::IO::STDIOStreamWrapperBase< T, typename >, and System::IO::UnmanagedMemoryStream.

◆ get_Position()

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

pure virtual

Returns the current position of the stream.

Returns: The current position of the stream.

Implemented in System::Net::Security::SslStream, System::Net::Sockets::NetworkStream, System::Security::Cryptography::CryptoStream, System::IO::BufferedStream, System::IO::FileStream, System::IO::MemoryStream, System::IO::STDIOStreamWrapperBase< T, typename >, and System::IO::UnmanagedMemoryStream.

◆ get_ReadTimeout()

virtual int System::IO::Stream::get_ReadTimeout ( ) const

virtual

Gets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.

Returns: A value in milliseconds that determines how long the stream will attempt to read before timing out.

Reimplemented in System::Net::Security::SslStream, and System::Net::Sockets::NetworkStream.

◆ get_WriteTimeout()

virtual int System::IO::Stream::get_WriteTimeout ( ) const

virtual

Gets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.

Reimplemented in System::Net::Security::SslStream, and System::Net::Sockets::NetworkStream.

◆ Read() [1/3]

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

pure virtual

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

Implemented in System::Net::Security::SslStream, System::Security::Cryptography::CryptoStream, System::IO::BufferedStream, System::IO::FileStream, System::IO::MemoryStream, System::IO::BasicSTDIStreamWrapper< T, typename >, System::IO::BasicSTDOStreamWrapper< T, typename >, System::IO::BasicSTDIOStreamWrapper< T, typename >, System::IO::UnmanagedMemoryStream, and System::Net::Sockets::NetworkStream.

◆ Read() [2/3]

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

virtual

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 in System::Net::Security::SslStream, System::Security::Cryptography::CryptoStream, System::IO::BufferedStream, System::IO::FileStream, System::IO::MemoryStream, System::IO::BasicSTDIStreamWrapper< T, typename >, System::IO::BasicSTDOStreamWrapper< T, typename >, System::IO::BasicSTDIOStreamWrapper< T, typename >, System::IO::UnmanagedMemoryStream, and System::Net::Sockets::NetworkStream.

◆ Read() [3/3]

template<std::size_t N>

int32_t System::IO::Stream::Read	(	const System::Details::StackArray< uint8_t, N > &	buffer,
		int32_t	offset,
		int32_t	count
	)

inline

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

Parameters

buffer	The byte stack 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

Template Parameters

N	The size of the stack array

Returns: The number of bytes read

◆ ReadAsync() [1/2]

RTaskPtr< int32_t > System::IO::Stream::ReadAsync	(	const ArrayPtr< uint8_t > &	buffer,
		int32_t	offset,
		int32_t	count
	)

Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

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: A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached.

◆ ReadAsync() [2/2]

virtual RTaskPtr< int32_t > System::IO::Stream::ReadAsync	(	const ArrayPtr< uint8_t > &	buffer,
		int32_t	offset,
		int32_t	count,
		const Threading::CancellationToken &	cancellationToken
	)

virtual

Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

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.
cancellationToken	The token to monitor for cancellation requests.

Returns: A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached.

Reimplemented in System::IO::FileStream.

◆ 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::BufferedStream, System::IO::FileStream, System::IO::MemoryStream, System::IO::BasicSTDIStreamWrapper< T, typename >, System::IO::BasicSTDOStreamWrapper< T, typename >, and System::IO::BasicSTDIOStreamWrapper< T, typename >.

◆ 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

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

Implemented in System::Net::Security::SslStream, System::Net::Sockets::NetworkStream, System::Security::Cryptography::CryptoStream, System::IO::UnmanagedMemoryStream, System::IO::BufferedStream, System::IO::FileStream, System::IO::MemoryStream, and System::IO::STDIOStreamWrapperBase< T, typename >.

◆ set_Position()

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

pure virtual

Sets the stream's position.

Parameters

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

Implemented in System::Net::Security::SslStream, System::Net::Sockets::NetworkStream, System::Security::Cryptography::CryptoStream, System::IO::BufferedStream, System::IO::FileStream, System::IO::MemoryStream, System::IO::STDIOStreamWrapperBase< T, typename >, and System::IO::UnmanagedMemoryStream.

◆ set_ReadTimeout()

virtual void System::IO::Stream::set_ReadTimeout ( int timeout )

virtual

Sets a value that determines whether the current stream can time out.

◆ set_WriteTimeout()

virtual void System::IO::Stream::set_WriteTimeout ( int timeout )

virtual

Sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.

◆ SetLength()

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

pure virtual

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

Parameters

value The length in bytes to set

Implemented in System::Net::Security::SslStream, System::Net::Sockets::NetworkStream, System::Security::Cryptography::CryptoStream, System::IO::BufferedStream, System::IO::FileStream, System::IO::MemoryStream, System::IO::BasicSTDIStreamWrapper< T, typename >, System::IO::BasicSTDOStreamWrapper< T, typename >, System::IO::BasicSTDIOStreamWrapper< T, typename >, and System::IO::UnmanagedMemoryStream.

◆ Write() [1/3]

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

pure virtual

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 element in `buffer` at which the subrange to write begins
count	The number of elements in the subrange to write

Implemented in System::Net::Security::SslStream, System::Security::Cryptography::CryptoStream, System::IO::BufferedStream, System::IO::FileStream, System::IO::MemoryStream, System::IO::BasicSTDIStreamWrapper< T, typename >, System::IO::BasicSTDOStreamWrapper< T, typename >, System::IO::BasicSTDIOStreamWrapper< T, typename >, System::IO::UnmanagedMemoryStream, and System::Net::Sockets::NetworkStream.

◆ Write() [2/3]

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

virtual

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 element in `buffer` at which the subrange to write begins
count	The number of elements in the subrange to write

Reimplemented in System::Net::Security::SslStream, System::Security::Cryptography::CryptoStream, System::IO::BufferedStream, System::IO::FileStream, System::IO::MemoryStream, System::IO::BasicSTDIStreamWrapper< T, typename >, System::IO::BasicSTDOStreamWrapper< T, typename >, System::IO::BasicSTDIOStreamWrapper< T, typename >, System::IO::UnmanagedMemoryStream, and System::Net::Sockets::NetworkStream.

◆ Write() [3/3]

template<std::size_t N>

void System::IO::Stream::Write	(	const System::Details::StackArray< uint8_t, N > &	buffer,
		int32_t	offset,
		int32_t	count
	)

inline

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

Parameters

buffer	The stack array containing the bytes to write
offset	A 0-based index of the element in `buffer` at which the subrange to write begins

Template Parameters

N	The size of the stack array

Parameters

count The number of elements in the subrange to write

◆ WriteAsync() [1/2]

TaskPtr System::IO::Stream::WriteAsync	(	const ArrayPtr< uint8_t > &	buffer,
		int32_t	offset,
		int32_t	count
	)

Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.

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.

Returns: A task that represents the asynchronous write operation.

◆ WriteAsync() [2/2]

virtual TaskPtr System::IO::Stream::WriteAsync	(	const ArrayPtr< uint8_t > &	buffer,
		int32_t	offset,
		int32_t	count,
		const Threading::CancellationToken &	cancellationToken
	)

virtual

Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.

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.
cancellationToken	The token to monitor for cancellation requests.

Returns: A task that represents the asynchronous write operation.

Reimplemented in System::IO::FileStream.

◆ WriteByte()

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

virtual

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

Parameters

value The value to write

Reimplemented in System::IO::BufferedStream, System::IO::FileStream, System::IO::MemoryStream, System::IO::BasicSTDIStreamWrapper< T, typename >, System::IO::BasicSTDOStreamWrapper< T, typename >, and System::IO::BasicSTDIOStreamWrapper< T, typename >.

Member Data Documentation

◆ Null

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

static

A stream with no underlying storage.

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Ptr

Member Function Documentation

◆ BeginRead()

◆ BeginWrite()

◆ Close()

◆ CopyTo() [1/2]

◆ CopyTo() [2/2]

◆ Dispose() [1/2]

◆ Dispose() [2/2]

◆ EndRead()

◆ EndWrite()

◆ Flush()

◆ FlushAsync() [1/2]

◆ FlushAsync() [2/2]

◆ get_CanRead()

◆ get_CanSeek()

◆ get_CanTimeout()

◆ get_CanWrite()

◆ get_Length()

◆ get_Position()

◆ get_ReadTimeout()

◆ get_WriteTimeout()

◆ Read() [1/3]

◆ Read() [2/3]

◆ Read() [3/3]

◆ ReadAsync() [1/2]

◆ ReadAsync() [2/2]

◆ ReadByte()

◆ Seek()

◆ set_Position()

◆ set_ReadTimeout()

◆ set_WriteTimeout()

◆ SetLength()

◆ Write() [1/3]

◆ Write() [2/3]

◆ Write() [3/3]

◆ WriteAsync() [1/2]

◆ WriteAsync() [2/2]

◆ WriteByte()

Member Data Documentation

◆ Null