FileHelper
Last updated
Last updated
FileHelper
class provides synchronous and asynchronous methods for the write, read and delete a single file.
Synchronously saves a byte array to a file by an absolute path.
By default, if the file exists, the FileHelper
creates a new file with a unique name and returns that name.
All parameters:
Param name | Param type | Description |
---|---|---|
Asynchronously saves a byte array to a file by an absolute path.
By default, if the file exists, the FileHelper
creates a new file with a unique name and returns that name.
All parameters:
Synchronously reads a file from an absolute path to a byte array.
All parameters:
You can also synchronously reads a file from a stream to a byte array.
All parameters:
Asynchronously reads a file from an absolute path to a byte array.
All parameters:
You can also asynchronously reads a file from a stream to a byte array.
All parameters:
Deletes a file if it exists.
All parameters:
Returns an absolute path with variable destination file name with sequential postfix e.g. ("file_1.txt", "file_2.txt").
All parameters:
Param name | Param type | Description |
---|---|---|
Param name | Param type | Description |
---|---|---|
Param name | Param type | Description |
---|---|---|
Param name | Param type | Description |
---|---|---|
Param name | Param type | Description |
---|---|---|
Param name | Param type | Description |
---|---|---|
Param name | Param type | Description |
---|---|---|
path
string
The absolute file path to save to.
bytes
byte[]
The bytes to save to the file.
createDirIfNotExists
bool
The flag indicates to create destination directory if not exists. Default value is true
.
useSequentialFileNameIfExists
bool
The flag indicates that target file name should be changed by adding sequential postfix if file with specfied name already exists. Default value is false
.
path
string
The absolute file path to save to.
bytes
byte[]
The bytes to save to the file.
createDirIfNotExists
bool
The flag indicates to create destination directory if not exists. Default value is true
.
useSequentialFileNameIfExists
bool
The flag indicates that target file name should be changed by adding sequential postfix if file with specfied name already exists. Default value is false
.
cancellationToken
CancellationToken
The token to monitor for cancellation requests. Default value is None
.
path
string
The absolute file path to read to.
throwIfNotExists
bool
The flag indicates to throw exception if file not exists. Default value is true
.
stream
Stream
The Stream (MemoryStream, FileStream, etc.).
initialLength
long
Length of returning byte array. Default value is 0
.
path
string
The absolute file path to read to.
throwIfNotExists
bool
The flag indicates to throw exception if file not exists. Default value is true
.
cancellationToken
CancellationToken
The token to monitor for cancellation requests. Default value is None
.
stream
Stream
The Stream (MemoryStream, FileStream, etc.).
initialLength
long
Length of returning byte array. Default value is 0
.
cancellationToken
CancellationToken
The token to monitor for cancellation requests. Default value is None
.
path
string
The absolute file path to delete to.
path
string
The absolute file path.