Represents a file stream supporting synchronous and asynchronous read and write operations. 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 <file_stream.h>

Inherits System::IO::Stream.

Public Member Functions
	FileStream (const String &path, FileMode mode)
	Constructs a new instance of FileStream class and initializes it with the specified parameters. More...

	FileStream (const String &path, FileMode mode, FileAccess access, FileShare share=FileShare::Read, int32_t buffer_size=DefaultBufferSize, FileOptions options=FileOptions::SequentialScan)
	Constructs a new instance of FileStream class and initializes it with the specified parameters. More...

	~FileStream ()
	Destructor. More...

	FileStream (const FileStream &)=delete

FileStream &	operator= (const FileStream &)=delete

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...

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

String	get_Name () const
	Returns the name of the file encapsulated by the current FileStream object. More...

void	set_Position (int64_t value) override
	Flushes the stream and then sets the stream's position. More...

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

void	Close () override
	Closes the current FileStream object. More...

void	Flush () override
	Clears this stream's buffers and writes all buffered data to the underlying file. More...

void	Flush (bool flush_to_disk)
	Clears this stream's buffers and writes all buffered data to the underlying file. Synonym for method Flush(). More...

int32_t	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...

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...

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	WriteByte (uint8_t value) override
	Writes the specified unsigned 8-bit integer value to the stream. 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...

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...

Static Public Attributes
static constexpr int32_t	DefaultBufferSize = 4096
	Default value of the number of bytes bufferred during read and write operations. More...

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

Additional Inherited Members
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...

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...

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 file stream supporting synchronous and asynchronous read and write operations. 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.

Constructor & Destructor Documentation

◆ FileStream() [1/3]

System::IO::FileStream::FileStream	(	const String &	path,
		FileMode	mode
	)

Constructs a new instance of FileStream class and initializes it with the specified parameters.

Parameters

path	The path of the file to open.
mode	Specifies the mode in which to open the file.

◆ FileStream() [2/3]

System::IO::FileStream::FileStream	(	const String &	path,
		FileMode	mode,
		FileAccess	access,
		FileShare	share = `FileShare::Read`,
		int32_t	buffer_size = `DefaultBufferSize`,
		FileOptions	options = `FileOptions::SequentialScan`
	)

Constructs a new instance of FileStream class and initializes it with the specified parameters.

Parameters

path	The path of the file to open.
mode	Specifies the mode in which to open the file.
access	The requested access type.
share	The type of access that other FileStream objects have to the opened file.
buffer_size	The number of bytes bufferred during read and write operations.
options	Additional options.

◆ ~FileStream()

System::IO::FileStream::~FileStream ( )

Destructor.

◆ FileStream() [3/3]

System::IO::FileStream::FileStream ( const FileStream & )

delete

Member Function Documentation

◆ Close()

void System::IO::FileStream::Close ( )

overridevirtual

Closes the current FileStream object.

Reimplemented from System::IO::Stream.

◆ Flush() [1/2]

void System::IO::FileStream::Flush ( )

overridevirtual

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

Implements System::IO::Stream.

◆ Flush() [2/2]

void System::IO::FileStream::Flush ( bool flush_to_disk )

Clears this stream's buffers and writes all buffered data to the underlying file. Synonym for method Flush().

Parameters

flush_to_disk True to flush all intermediate buffers, otherwise - false.

◆ get_CanRead()

bool System::IO::FileStream::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::FileStream::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::FileStream::get_CanWrite ( ) const

overridevirtual

Determines if the stream is writable.

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

Implements System::IO::Stream.

◆ get_Length()

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

overridevirtual

Returns the length of the stream in bytes.

Implements System::IO::Stream.

◆ get_Name()

String System::IO::FileStream::get_Name ( ) const

Returns the name of the file encapsulated by the current FileStream object.

◆ get_Position()

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

overridevirtual

Returns the current position of the stream.

Implements System::IO::Stream.

◆ operator=()

FileStream & System::IO::FileStream::operator= ( const FileStream & )

delete

◆ Read() [1/2]

int32_t System::IO::FileStream::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::FileStream::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()

int32_t System::IO::FileStream::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::FileStream::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_Position()

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

overridevirtual

Flushes the stream and then 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::FileStream::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.

◆ Write() [1/2]

void System::IO::FileStream::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::FileStream::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::FileStream::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.

Member Data Documentation

◆ DefaultBufferSize

constexpr int32_t System::IO::FileStream::DefaultBufferSize = 4096

staticconstexpr

Default value of the number of bytes bufferred during read and write operations.

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FileStream() [1/3]

◆ FileStream() [2/3]

◆ ~FileStream()

◆ FileStream() [3/3]

Member Function Documentation

◆ Close()

◆ Flush() [1/2]

◆ Flush() [2/2]

◆ get_CanRead()

◆ get_CanSeek()

◆ get_CanWrite()

◆ get_Length()

◆ get_Name()

◆ get_Position()

◆ operator=()

◆ Read() [1/2]

◆ Read() [2/2]

◆ ReadByte()

◆ Seek()

◆ set_Position()

◆ SetLength()

◆ Write() [1/2]

◆ Write() [2/2]

◆ WriteByte()

Member Data Documentation

◆ DefaultBufferSize