Interface IFileOperationsService

Defines a service for file system operations.

Namespace: Coree.NETStandard.Services.FileOperationsManagement

Assembly: Coree.NETStandard.dll

Syntax

public interface IFileOperationsService

Methods

CopyFileAttributes(string, string, bool)

Copies the file attributes and UTC timestamps from a source file to a destination file. This method provides an option to control exception handling based on the failure conditions encountered during the operation.

Declaration

bool CopyFileAttributes(string source, string destination, bool throwOnError = false)

Parameters

Type	Name	Description
string	source	The source file path. This must point to an existing file, or the method will handle the error based on the throwOnError parameter.
string	destination	The destination file path. This must point to an existing file, or the method will handle the error based on the throwOnError parameter.
bool	throwOnError	Indicates whether to throw an exception when the operation fails due to the non-existence of the source or destination, or due to other errors during the copying process. If set to false, the method logs a warning and returns false instead of throwing.

Returns

Type	Description
bool	True if the file metadata was successfully copied; otherwise, false. If false is returned, check logs for the specific failure reason.

CreateJsonPathInventoryAsync(string?, string, CancellationToken)

Declaration

Task CreateJsonPathInventoryAsync(string? path, string inventoryFilename = "", CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	path
string	inventoryFilename
CancellationToken	cancellationToken

Returns

Type	Description
Task

DeleteFile(string, bool)

Attempts to delete a file at a specified location. It logs the operation and can optionally throw an exception on error.

Declaration

bool DeleteFile(string filePath, bool throwOnError = false)

Parameters

Type	Name	Description
string	filePath	The path of the file to be deleted.
bool	throwOnError	Specifies whether to throw an exception if the deletion fails due to an error.

Returns

Type	Description
bool	True if the file was deleted successfully or did not exist; false if an error occurred during deletion.

FileCopyAsync(string, string, CancellationToken)

Asynchronously copies a file from a source path to a destination path, overwriting the destination file if it already exists.

Declaration

Task<bool> FileCopyAsync(string source, string destination, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	source	The file path of the source file to be copied.
string	destination	The file path of the destination where the file will be copied.
CancellationToken	cancellationToken	A cancellation token that can be used to cancel the file copy operation.

Returns

Type	Description
Task<bool>	Returns true if the file is copied successfully. If the file is not copied, the method throws an exception.

Remarks

This method wraps the RetryVerifyAndResumeFileCopyAsync(string, string, CancellationToken, int, int) method to include asynchronous execution with cancellation support and retry logic. It logs the attempt, success, or failure of the file copying process. Use the provided cancellationToken to cancel the operation if needed.

InventoryCopyAsync(string, string)

Declaration

Task InventoryCopyAsync(string inventoryFilename, string target)

Parameters

Type	Name	Description
string	inventoryFilename
string	target

Returns

Type	Description
Task

RetryVerifyAndResumeFileCopyAsync(string, string, CancellationToken, int, int)

Attempts to verify and resume a file copy operation multiple times in case of failures during the copy process.

Declaration

Task<FileOperationsService.VerifiedCopyStatus> RetryVerifyAndResumeFileCopyAsync(string source, string destination, CancellationToken cancellationToken = default, int maxRetryCount = 3, int retryDelayMilliseconds = 1000)

Parameters

Type	Name	Description
string	source	The source file path from which to copy.
string	destination	The destination file path to which the file should be copied.
CancellationToken	cancellationToken	Token to monitor for cancellation requests.
int	maxRetryCount	The maximum number of retry attempts for the copy operation.
int	retryDelayMilliseconds	The delay in milliseconds between retry attempts.

Returns

Type	Description
Task<FileOperationsService.VerifiedCopyStatus>	A task that represents the asynchronous operation, with a value indicating the result of the copy operation after retries.

Remarks

This method encapsulates a retry logic for the VerifyAndResumeFileCopyAsync method. It retries the file copy operation up to a specified number of times if the error is related to the copy process itself. Each retry is logged and, if necessary, followed by a specified delay. If the copy operation fails after all retries or is cancelled, the method will return the appropriate status.

// Example usage of retrying a file copy operation
var copyStatus = await RetryVerifyAndResumeFileCopyAsync("path/to/source.file", "path/to/destination.file");
if (copyStatus == VerifiedCopyStatus.Success)
{
    Console.WriteLine("File copy succeeded after retries.");
}
else
{
    Console.WriteLine($"File copy failed with status: {copyStatus}");
}

ScanFileSystemEntriesAsync(string, CancellationToken, bool, bool, List<string>?)

Asynchronously scans the file system entries starting from the specified path, optionally performing CRC32 checks and applying a blacklist filter on file names.

Declaration

Task<FileOperationsService.FileSystemInformation> ScanFileSystemEntriesAsync(string path, CancellationToken cancellationToken, bool failFast = false, bool crc32 = false, List<string>? fileNameBlacklist = null)

Parameters

Type	Name	Description
string	path	The starting path from which to begin scanning for file system entries.
CancellationToken	cancellationToken	A token to monitor for cancellation requests, which can abort the operation.
bool	failFast	If set to true, the operation will stop at the first error encountered; otherwise, it will continue despite errors.
bool	crc32	If set to true, a CRC32 checksum will be calculated for each file.
List<string>	fileNameBlacklist	An optional list of file names to exclude from scanning and processing.

Returns

Type	Description
Task<FileOperationsService.FileSystemInformation>	A FileSystemInformation object containing all scanned entries, including any errors encountered during the scan.

VerifyAndResumeFileCopyAsync(string, string, CancellationToken)

Verifies the integrity of a partially copied file and resumes the copy operation if integrity is confirmed.

Declaration

Task<FileOperationsService.VerifiedCopyStatus> VerifyAndResumeFileCopyAsync(string source, string destination, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	source	The source file path.
string	destination	The destination file path.
CancellationToken	cancellationToken	Token to monitor for cancellation requests.

Returns

Type	Description
Task<FileOperationsService.VerifiedCopyStatus>	A task that represents the asynchronous operation, with a value indicating the result of the copy operation.

Remarks

This method uses a two-phase approach: first, it verifies the existing part of the file in the destination against the source. If the verification is successful, it resumes copying. If there is a mismatch, it truncates the destination file to the last verified position and resumes the copy.

var status = await VerifyAndResumeFileCopyAsync("path/to/source.file", "path/to/destination.file");
if (status == VerifiedCopyStatus.Success)
{
    Console.WriteLine("File copied successfully.");
}