EQXMedia.TxFileSystem 3.0.0-beta1

Prefix Reserved
.NET 5.0 This package targets .NET 5.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. .NET Framework 4.6.1 This package targets .NET Framework 4.6.1. The package is compatible with this framework or higher.
This is a prerelease version of EQXMedia.TxFileSystem.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package EQXMedia.TxFileSystem --version 3.0.0-beta1                

                    
                

            
NuGet\Install-Package EQXMedia.TxFileSystem -Version 3.0.0-beta1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="EQXMedia.TxFileSystem" Version="3.0.0-beta1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add EQXMedia.TxFileSystem --version 3.0.0-beta1                

                    
                

            
#r "nuget: EQXMedia.TxFileSystem, 3.0.0-beta1"
#r directive can be used in F# Interactive and Polyglot Notebooks. 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=3.0.0-beta1&prerelease

// Install EQXMedia.TxFileSystem as a Cake Tool
#tool nuget:?package=EQXMedia.TxFileSystem&version=3.0.0-beta1&prerelease

EQXMedia.TxFileSystem

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

This file system wrapper supports transactional operations on:

  • Files,
  • Directories,
  • File streams.

About the Project

Build Status

.NET

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 documentation of the library 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 3.0.0-beta1
.NET CLI
$ dotnet add package EQXMedia.TxFileSystem --version 3.0.0-beta1
Package Reference
<PackageReference Include="EQXMedia.TxFileSystem" Version="3.0.0-beta1" />

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();
Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 is compatible.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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
3.0.0 0 11/13/2024
3.0.0-beta1 43 11/11/2024
2.1.1 401 1/5/2022
2.1.0 492 12/29/2021 2.1.0 is deprecated.
2.0.2 327 5/19/2021
2.0.1 574 5/1/2021 2.0.1 is deprecated because it has critical bugs.
2.0.0 558 4/27/2021 2.0.0 is deprecated because it has critical bugs.
1.3.0 314 4/16/2021
1.2.0 329 4/10/2021
1.1.1 330 4/8/2021
1.1.0 951 4/8/2021 1.1.0 is deprecated because it has critical bugs.
1.0.0 305 4/7/2021

Version 2.2.0

● Supports `System.IO.Abstractions` 17.2.3 and onwards.
● TxFileSystem class is now a IFileSystem implementation too.
● Exposing the TxFileSystem on property instances too to maintain data integrity.
● Plain proxy functionality for all remaining parts of the System.IO.Abstractions interfaces.
● Added support for IntelliSense.
● Added support for Symbol files (.pdb).
● Added testing helpers to aid projects in Unit Testing.
● Added documentation for all supported framework versions:
 ○ Generated HTML Documentation.
 ○ Generated Windows Help File.
● Now supports multiple framework versions:
 ○ .NET Framework 4.6.1,
 ○ .NET Standard 2.0,
 ○ .NET Standard 2.1,
 ○ .NET 5.0,
 ○ .NET 6.0.
● Unit Testing all supported framework versions.
● Fully covered by Unit Tests (100% code coverage).