TempFileStream 1.0.0

.NET 5.0 .NET Core 3.1 .NET Standard 2.0
There is a newer version of this package available.
See the version list below for details.
dotnet add package TempFileStream --version 1.0.0
NuGet\Install-Package TempFileStream -Version 1.0.0
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="TempFileStream" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add TempFileStream --version 1.0.0
#r "nuget: TempFileStream, 1.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 TempFileStream as a Cake Addin
#addin nuget:?package=TempFileStream&version=1.0.0

// Install TempFileStream as a Cake Tool
#tool nuget:?package=TempFileStream&version=1.0.0

Temp File Stream

Makes using disk-backed temporary storage as simple as using a MemoryStream. Implements IDisposable. Geared towards net core services using DI (IServiceProvider).

Interfaces commonly consumed

To create a temp file, use ITempFileFactory's CreateTempFile method. This provides an instance of ITempFile, with its WriteStream property available for immediate use. Write information to the WriteStream, then dispose the WriteStream. To re-open the same temp file for reading, call CreateReadStream on the ITempFile. When done working with the temp file, dispose the read stream, and then dispose the ITempFile instance.

Temp File naming

Temp file names incorporate a cryptograhpically sound unique identifier, when the default namer (TempFileNamer) is used. This default namer is registered as part of the call to services.AddTempFileStream.

Configuration

The root folder where temp files are placed, file name prefix, and stream behaviors may be configured using TempFileStreamConfig. By default, Path.GetTempPath is used, and temp file names bear no prefix. The default configuration is suitable for many use cases.

DI Registration

// without any particular configuration (suitable for many use cases)
services.AddTempFileStream();

// with custom configuration
services.AddTempFileStream().Configure<TempFileStreamConfig>(cfg =>
              {
                  cfg.Prefix = "someunit_";
              });

Example Usage

var tempFileFactory = serviceProvider.GetRequiredService<ITempFileFactory>();
using (var tempFile = tempFileFactory.CreateTempFile())
{
    // writeout data to temp file's write stream, and dispose the write stream
    using (var ws = tempFile.WriteStream)
    {
        ws.Write(buf, 0, buf.Length);
    }

    // now re-open it for reading etc.
    using (var readStream = tempFile.CreateReadStream())
    {
        // ...
    }
}
Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
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
2.0.0 222 9/3/2021
1.0.1 240 8/14/2021
1.0.0 235 8/14/2021