VersaTul.Handler.File 1.0.19

VersaTul Handler File

This project provides the functionality needed to work with files on hard-disks. It supports creating, reading, and deleting of custom file types found in the project. It is a wrapper project around the System.IO.File namespace and was designed to make working with the VersaTul custom FileInfo class much easier.

Features

• IDirectoryWrapper: Interface used to expose System.IO.File methods pertaining to Directory manipulation.
• IFileHandler: Interface used for providing the general File manipulation functionalities.
• IFileWrapper: Interface used to expose System.IO.File methods pertaining to File manipulation.
• IFileUtility: Interface used to provide File and Directory read and write functionalities. Inherits the IFileHandler interface.
• FileHandler: An abstract class that implements the IFileHandler Interface.
• FileUtility: The concrete implementation of the IFileUtility Interface.
• DirectoryWrapper: The concrete implementation of IDirectoryWrapper and IFileWrapper Interfaces.
• BaseInfo: An abstract base class that represents the basic information provided by a FileInfo class.
• FileInfo: A custom VersaTul class used to represent a file details and its contents.
• CsvFileInfo: Class that represents a csv file details and its contents.
• TextFileInfo: Class that represents a text file details and its contents.
• ZipFileInfo: Class that represents a zip file details and its contents as a stream.
• StreamFileInfo: Class that represents a file details and its contents as a stream.
• CustomFileInfo: Class used to represent a custom file (maybe a project specific file with its own extension) details and its contents.

Usage

To use this project, you need to create instances of the classes and interfaces provided. For example, to read data from a file, you can use the following code:

using VersaTul.Handler.File.Contracts;
using VersaTul.Handler.File.Types;
using VersaTul.Utilities.Contracts;

class Program
{
    static void Main(string[] args)
    {
        // Create instances
        var directoryWrapper = new DirectoryWrapper();
        var fileUtility = new FileUtility(directoryWrapper, directoryWrapper);

        // file to read
        var fullFilePath = "c:\\some\\path\\filename.txt";

        // Open and read data from file.
        FileResult data = fileUtility.ReadAllLines(fullFilePath);

        if (data.IsExists)
        {
            Print("Here is your file data");
            Print("=========================");
            data.Content.ToList().ForEach(val => Print(val));
        }
        else
        {
            Print($"No file @:' {fullFilePath}'");
        }
    }

    Console.ReadLine();
}

For more details on the methods and parameters of each class and interface, please refer to the web page VersaTul Handler File.

License

This project is licensed under the MIT License - see the LICENSE file for details.