Transactional.IO 1.0.1

There is a newer version of this package available.
See the version list below for details.

dotnet add package Transactional.IO --version 1.0.1

NuGet\Install-Package Transactional.IO -Version 1.0.1

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="Transactional.IO" Version="1.0.1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add Transactional.IO --version 1.0.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Transactional.IO, 1.0.1"

#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 Transactional.IO as a Cake Addin
#addin nuget:?package=Transactional.IO&version=1.0.1

// Install Transactional.IO as a Cake Tool
#tool nuget:?package=Transactional.IO&version=1.0.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

📁 Transactional.IO

A dead simple way to manage your FileStream in a transactional way to ensure that the file does not get corrupted if things don't go as planned.

Take an example with XmlWriter (note that any StreamWriter is compatible, including the direct access!)

using Transactional.IO;
using System.Xml;

using var stream = new TransactionalFileStream("my-file.xml", FileMode.Truncate);
using var writer = XmlWriter.Create(stream);

var userFullName = "";

writer.WriteStartDocument();
writer.WriteStartElement("User");
if (userFullName == "")
{
    // ❌ This interrupts execution and writer does not finish.
    // Your file would be left corrupted with half of XML missing.
    throw new Exception("Uh-oh!"); 
}
writer.WriteValue(userFullName);
writer.WriteEndElement();

writer.WriteEndDocument();

// ✅ But don't fret! 
// As long as .Commit() was not called, the original file is left unchanged.
stream.Commit();

🌟 Features

As simple as it gets, no bloated custom APIs
Extends standard System.IO.FileStream

📦️ Get started

Download from nuget.org:

dotnet add package Transactional.IO

Product	Compatible and additional computed target framework versions.
.NET	net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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 was computed. 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 was computed. 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 was computed.
.NET Framework	net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed.
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.

.NETStandard 2.0
- No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.