UploadStream 2.2.0

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

// Install UploadStream as a Cake Tool
#tool nuget:?package=UploadStream&version=2.2.0

High performance file upload streaming for dotnet

Installation

Nuget: https://www.nuget.org/packages/UploadStream

> install-package UploadStream

Features

Optimise multi-part streaming file upload performance, reduced CPU usage ~25% (us) and Memory impact ~50% (gen0 gc).

By default dotnet model form model binding loads the entire stream into memory using IEnumerable<IFormFile> - this is non-ideal for large files where processing of the stream should occur during streaming rather then buffering entire file(s) to memory/disk.

This package allows upload streams to be asynchronously processed via a delegate - StreamFiles<T>(Action<IFormFile> func), maintaining generic model binding functionality with ModelState validation - default form model binding is disabled via a custom [DisableFormModelBinding] attribute.

Usage

[HttpPost("upload")]
// disable default model binding in order to enable processing of streams without buffering entire stream
// (only if additional Model binding is required, if no arguments passed then Form Model binding isn't triggered).
[DisableFormModelBinding]
public async Task<IActionResult> Upload(MyRouteModel routeModel) {
    // returns a generic typed model, alternatively non-generic overload if no model binding is required
    MyModel model = await this.StreamFiles<MyModel>(async formFile => {
        // implement processing of stream as required via an IFormFile interface
        using (var stream = formfile.OpenReadStream())
            await ...
    });
    // ModelState is still validated from model
    if(!ModelState.IsValid)
        ...
}
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 is compatible.  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.

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.1.1 167,576 3/5/2020
3.1.0 716 3/5/2020
2.2.0 23,510 12/5/2018
1.0.1 2,145 6/9/2018
1.0.0 2,191 5/29/2018