System::IO::FileStream Class Reference

Inherits System::IO::Stream.

Public Member Functions

ASPOSECPP_SHARED_API FileStream (const String &path, FileMode mode, FileAccess access=FileAccess::ReadWrite, FileShare share=FileShare::ReadWrite, int bufferSize=DefaultBufferSize, FileOptions options=FileOptions::SequentialScan)
 
ASPOSECPP_SHARED_API ~FileStream ()
 Destructor. More...
 
ASPOSECPP_SHARED_API bool get_CanRead () const override
 
ASPOSECPP_SHARED_API bool get_CanSeek () const override
 
ASPOSECPP_SHARED_API bool get_CanWrite () const override
 
ASPOSECPP_SHARED_API int64_t get_Length () const override
 Returns the length of the stream in bytes. More...
 
ASPOSECPP_SHARED_API String get_Name () const
 Returns the name of the file encapsulated by the current FileStream object. More...
 
ASPOSECPP_SHARED_API void set_Position (int64_t value) override
 
ASPOSECPP_SHARED_API int64_t get_Position () const override
 Returns the current position of the stream. More...
 
ASPOSECPP_SHARED_API void Close () override
 Closes the current BinaryReader object and the underlying input stream. More...
 
ASPOSECPP_SHARED_API void Flush () override
 Clears this stream's buffers and writes all buffered data to the underlying file. More...
 
ASPOSECPP_SHARED_API void Flush (bool flushToDisk)
 
ASPOSECPP_SHARED_API int ReadByte () override
 
ASPOSECPP_SHARED_API int Read (ArrayPtr< uint8_t > buffer, int offset, int count) override
 
ASPOSECPP_SHARED_API int64_t Seek (int64_t offset, SeekOrigin origin) override
 
ASPOSECPP_SHARED_API void SetLength (int64_t value) override
 
ASPOSECPP_SHARED_API void WriteByte (uint8_t value) override
 
ASPOSECPP_SHARED_API void Write (ArrayPtr< uint8_t > buffer, int offset, int count) override
 
- Public Member Functions inherited from System::IO::Stream
virtual ASPOSECPP_SHARED_API void Dispose () override
 Releases all resources used by the current object and closes the stream. More...
 
virtual ASPOSECPP_SHARED_API System::SharedPtr< System::IAsyncResultBeginRead (System::ArrayPtr< uint8_t > buffer, int offset, int count, System::AsyncCallback callback, System::SharedPtr< System::Object > state)
 
virtual ASPOSECPP_SHARED_API System::SharedPtr< System::IAsyncResultBeginWrite (System::ArrayPtr< uint8_t > buffer, int offset, int count, System::AsyncCallback callback, System::SharedPtr< System::Object > state)
 
virtual ASPOSECPP_SHARED_API int EndRead (System::SharedPtr< System::IAsyncResult > asyncResult)
 
virtual ASPOSECPP_SHARED_API void EndWrite (System::SharedPtr< System::IAsyncResult > asyncResult)
 
virtual ASPOSECPP_SHARED_API bool get_CanTimeout () const
 Gets a value that determines whether the current stream can time out. More...
 
virtual ASPOSECPP_SHARED_API void set_ReadTimeout (int timeout)
 
virtual ASPOSECPP_SHARED_API int get_ReadTimeout () const
 Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. More...
 
virtual ASPOSECPP_SHARED_API void set_WriteTimeout (int timeout)
 
virtual ASPOSECPP_SHARED_API int get_WriteTimeout () const
 Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (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 int const ASPOSECPP_SHARED_API DefaultBufferSize
 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 > ASPOSECPP_SHARED_API Null
 A stream with no underlying storage. More...
 

Additional Inherited Members

- Public Types inherited from System::IO::Stream
typedef SharedPtr< StreamPtr
 An alias for a shared pointer to this class. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. 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 TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 
- Protected Member Functions inherited from System::IO::Stream
virtual ASPOSECPP_SHARED_API void Dispose (bool disposing)
 

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()

ASPOSECPP_SHARED_API System::IO::FileStream::FileStream ( const String path,
FileMode  mode,
FileAccess  access = FileAccess::ReadWrite,
FileShare  share = FileShare::ReadWrite,
int  bufferSize = DefaultBufferSize,
FileOptions  options = FileOptions::SequentialScan 
)

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

Parameters
pathThe path of the file to open
modeSpecifies the mode in which to open the flie
accessThe requested access type
shareThe type of access that other FileStream objects have to the opened file
bufferSizeThe number of bytes bufferred during read and write operations
optionsAdditional options

◆ ~FileStream()

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

Destructor.

Member Function Documentation

◆ Close()

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

Closes the current BinaryReader object and the underlying input stream.

Reimplemented from System::IO::Stream.

◆ Flush() [1/2]

ASPOSECPP_SHARED_API 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]

ASPOSECPP_SHARED_API void System::IO::FileStream::Flush ( bool  flushToDisk)

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

Parameters
flushToDiskIGNORED

◆ get_CanRead()

ASPOSECPP_SHARED_API 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()

ASPOSECPP_SHARED_API 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()

ASPOSECPP_SHARED_API 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()

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

Returns the length of the stream in bytes.

Implements System::IO::Stream.

◆ get_Name()

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

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

◆ get_Position()

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

Returns the current position of the stream.

Implements System::IO::Stream.

◆ Read()

ASPOSECPP_SHARED_API int System::IO::FileStream::Read ( ArrayPtr< uint8_t >  buffer,
int  offset,
int  count 
)
overridevirtual

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

Implements System::IO::Stream.

◆ ReadByte()

ASPOSECPP_SHARED_API int 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()

ASPOSECPP_SHARED_API int64_t System::IO::FileStream::Seek ( int64_t  offset,
SeekOrigin  origin 
)
overridevirtual

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

Implements System::IO::Stream.

◆ set_Position()

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

Flushes the stream and then sets the stream's position.

Parameters
valueThe byte offset to set the stream's position to

Implements System::IO::Stream.

◆ SetLength()

ASPOSECPP_SHARED_API void System::IO::FileStream::SetLength ( int64_t  value)
overridevirtual

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

Parameters
valueThe length in bytes to set

Implements System::IO::Stream.

◆ Write()

ASPOSECPP_SHARED_API void System::IO::FileStream::Write ( ArrayPtr< uint8_t >  buffer,
int  offset,
int  count 
)
overridevirtual

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

Implements System::IO::Stream.

◆ WriteByte()

ASPOSECPP_SHARED_API void System::IO::FileStream::WriteByte ( uint8_t  value)
overridevirtual

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

Parameters
valueThe value to write

Reimplemented from System::IO::Stream.

Member Data Documentation

◆ DefaultBufferSize

int const ASPOSECPP_SHARED_API System::IO::FileStream::DefaultBufferSize
static

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