System::IO::FileStream Class Reference

Inherits System::IO::Stream.

Public Member Functions

 FileStream (const String &path, FileMode mode)
 
 FileStream (const String &path, FileMode mode, FileAccess access, FileShare share=FileShare::Read, int32_t buffer_size=DefaultBufferSize, FileOptions options=FileOptions::SequentialScan)
 
 ~FileStream ()
 Destructor. More...
 
 FileStream (const FileStream &)=delete
 
FileStreamoperator= (const FileStream &)=delete
 
bool get_CanRead () ASPOSE_CONST override
 
bool get_CanSeek () ASPOSE_CONST override
 
bool get_CanWrite () ASPOSE_CONST override
 
int64_t get_Length () ASPOSE_CONST override
 Returns the length of the stream in bytes. More...
 
String get_Name () ASPOSE_CONST
 Returns the name of the file encapsulated by the current FileStream object. More...
 
void set_Position (int64_t value) override
 
int64_t get_Position () ASPOSE_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)
 
int32_t ReadByte () override
 
int32_t Read (ArrayPtr< uint8_t > buffer, int32_t offset, int32_t count) override
 
int64_t Seek (int64_t offset, SeekOrigin origin) override
 
void SetLength (int64_t value) override
 
void WriteByte (uint8_t value) override
 
void Write (ArrayPtr< uint8_t > buffer, int32_t offset, int32_t count) override
 
- Public Member Functions inherited from System::IO::Stream
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 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 bool get_CanTimeout () ASPOSE_CONST
 Gets a value that determines whether the current stream can time out. More...
 
virtual void set_ReadTimeout (int timeout)
 
virtual int get_ReadTimeout () ASPOSE_CONST
 Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. More...
 
virtual void set_WriteTimeout (int timeout)
 
virtual int get_WriteTimeout () ASPOSE_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
 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...
 
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...
 
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. 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 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< StreamNull
 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 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() [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
pathThe path of the file to open.
modeSpecifies 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
pathThe path of the file to open.
modeSpecifies the mode in which to open the file.
accessThe requested access type.
shareThe type of access that other FileStream objects have to the opened file.
buffer_sizeThe number of bytes bufferred during read and write operations.
optionsAdditional 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_diskTrue to flush all intermediate buffers, otherwise - false.

◆ get_CanRead()

bool System::IO::FileStream::get_CanRead ( )
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 ( )
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 ( )
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 ( )
overridevirtual

Returns the length of the stream in bytes.

Implements System::IO::Stream.

◆ get_Name()

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

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

◆ get_Position()

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

Returns the current position of the stream.

Implements System::IO::Stream.

◆ operator=()

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

◆ Read()

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

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.

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

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

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

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

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.

◆ WriteByte()

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

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

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