TempFileStream 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())
    {
        // ...
    }
}