EQXMedia.TxFileSystem
3.0.0
Prefix Reserved
dotnet add package EQXMedia.TxFileSystem --version 3.0.0
NuGet\Install-Package EQXMedia.TxFileSystem -Version 3.0.0
<PackageReference Include="EQXMedia.TxFileSystem" Version="3.0.0" />
paket add EQXMedia.TxFileSystem --version 3.0.0
#r "nuget: EQXMedia.TxFileSystem, 3.0.0"
// Install EQXMedia.TxFileSystem as a Cake Addin #addin nuget:?package=EQXMedia.TxFileSystem&version=3.0.0 // Install EQXMedia.TxFileSystem as a Cake Tool #tool nuget:?package=EQXMedia.TxFileSystem&version=3.0.0
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
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 | Versions 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. |
-
.NETFramework 4.6.1
- System.IO.Abstractions (>= 17.2.3)
-
.NETFramework 4.8.1
- System.IO.Abstractions (>= 17.2.3)
-
.NETStandard 2.0
- System.IO.Abstractions (>= 17.2.3)
- System.Memory (>= 4.5.4)
-
.NETStandard 2.1
- System.IO.Abstractions (>= 17.2.3)
-
net5.0
- System.IO.Abstractions (>= 17.2.3)
- System.IO.FileSystem (>= 4.3.0)
- System.IO.FileSystem.AccessControl (>= 5.0.0)
-
net6.0
- System.IO.Abstractions (>= 17.2.3)
- System.IO.FileSystem (>= 4.3.0)
- System.IO.FileSystem.AccessControl (>= 5.0.0)
-
net7.0
- System.IO.Abstractions (>= 17.2.3)
- System.IO.FileSystem (>= 4.3.0)
- System.IO.FileSystem.AccessControl (>= 5.0.0)
-
net8.0
- System.IO.Abstractions (>= 17.2.3)
- System.IO.FileSystem (>= 4.3.0)
- System.IO.FileSystem.AccessControl (>= 5.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version 3.0.0
● Switched to SonarQube Cloud for SAST.
● Building and Unit Testing with GitHub Actions.
● Added support for symbolic links.
● Fixed bug caused by referencing ACL methods on Unix systems.
● 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 Framework 4.8.1,
○ .NET Standard 2.0,
○ .NET Standard 2.1,
○ .NET 5.0,
○ .NET 6.0,
○ .NET 7.0,
○ .NET 8.0.
● Unit Testing all supported framework versions.
● Fully covered by Unit Tests (100% code coverage).