EQXMedia.TxFileSystem 2.0.0

There is a newer version of this package available.
See the version list below for details.
Install-Package EQXMedia.TxFileSystem -Version 2.0.0
dotnet add package EQXMedia.TxFileSystem --version 2.0.0
<PackageReference Include="EQXMedia.TxFileSystem" Version="2.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add EQXMedia.TxFileSystem --version 2.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: EQXMedia.TxFileSystem, 2.0.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install EQXMedia.TxFileSystem as a Cake Addin
#addin nuget:?package=EQXMedia.TxFileSystem&version=2.0.0

// Install EQXMedia.TxFileSystem as a Cake Tool
#tool nuget:?package=EQXMedia.TxFileSystem&version=2.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

EQXMedia.TxFileSystem

EQXMedia.TxFileSystem is a transactional filesystem wrapper using the .NET filesystem abstraction from System.IO.Abstractions.

This filesystem wrapper supports transactional operations on:

  • Files,
  • Directories,
  • Filestreams.

About the Project

Project Development

This library has been designed and implemented by Jarno Kamminga for EQX Media B.V., and published as an OpenSource project on GitHub.

Project Website

The project has a website of its own which can be found at https://txfilesystem.io/.

Library Documentation

The library documentation can be found at https://txfilesystem.io/docs/.

NuGet Package

A NuGet package is created of every EQXMedia.TxFileSystem release and can be installed to your .NET project using the NuGet Package Manager or dotnet command.

More information about the NuGet package can be found at NuGet.org:

https://www.nuget.org/packages/EQXMedia.TxFileSystem/

Installing the package

Package Manager
PS> Install-Package EQXMedia.TxFileSystem -Version 2.0.0
.NET CLI
$ dotnet add package EQXMedia.TxFileSystem --version 2.0.0
Package Reference
<PackageReference Include="EQXMedia.TxFileSystem" Version="2.0.0" />

Code Example


/**
*
* Because an error occurs inside the transaction scope, the creation of the file will not take place
* (or better said be rolled back):
*
* txFileSystem.File.Exists(@"C:\Users\JohnDoe\Documents\example.txt");
*
* Would simply return 'false' after execution of the below code.
*
**/

using System;
using System.IO.Abstractions;
using System.Transactions;
using EQXMedia.TxFileSystem;
    
using var transactionScope = TransactionScope();

var txFileSystem = new TxFileSystem(new FileSystem());
txFileSystem.File.Create(@"C:\Users\JohnDoe\Documents\example.txt");

throw new Exception("Error occurs after creating the file. Resulting in the creation to be rolled back.");

transactionScope.Complete();

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.2 95 5/19/2021
2.0.1 136 5/1/2021
2.0.0 120 4/27/2021
1.3.0 90 4/16/2021
1.2.0 74 4/10/2021
1.1.1 87 4/8/2021
1.1.0 428 4/8/2021
1.0.0 78 4/7/2021

Version 2.0.0
-------------

● TxFileSystem class is now a IFileSystem implementation too.
● Exposing the TxFileSystem on property instances too to maintain data integrity.
● Added support for IntelliSense.
● Added documentation for all supported framework versions:
 ○ Generated HTML Documentation.
 ○ Generated Windows Help File.
● Providing a System.IO.Abstractions filesystem wrapper.
● Can be used to wrap any filesystem that implements the IFileSystem interface.
● Support transactional operations on:
 ○ Files,
 ○ Directories,
 ○ Filestreams.
● Plain proxy functionality for all remaining parts of the System.IO.Abstractions interfaces.
● Fully covered by Unit Tests (100% code coverage).
● Added support for .NET Framework 4.6.1, as per System.IO.Abstractions.
● Now supports multiple framework versions:
 ○ .NET Standard 2.0,
 ○ .NET Standard 2.1,
 ○ .NET 5.0.
 ○ .NET Framework 4.6.1.
● Unit Testing all supported framework versions.