StreamScribe 1.0.0

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. 
dotnet add package StreamScribe --version 1.0.0
                    


                    

                
NuGet\Install-Package StreamScribe -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="StreamScribe" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="StreamScribe" Version="1.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="StreamScribe" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add StreamScribe --version 1.0.0
                    


                    

                
#r "nuget: StreamScribe, 1.0.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. 
#:package StreamScribe@1.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=StreamScribe&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=StreamScribe&version=1.0.0
                    


                            Install as a Cake Tool

StreamScribe - Mutable and Immutable binary stream operations.

Contents:
  • IImmutableStream - Stream with predefined context, usually it's used for read-only operations.
  • IMutableStream - Stream without predefined context, used for read and write operations.
  • IInteractivePointer - Used internally to keep track of the current pointer position for either the IImmutableStream or IMutableStream.
  • MemoryPartitioner - Provides an easy way to 'cut' any IEnumerable<byte> into separate chunks.
  • MemoryChunk - Is a record struct which contains data generated by MemoryPartitioner.
How to create streams:

To create IImmutableStream or IMutableStream we'll use the IStreamBuilder and it's implementation StreamBuilder.

IMutableStream without initial context:

using (var stream = StreamBuilder.GetInstance().BuildMutableStream())
{
    stream.WriteUInt8(0xFF);
}

or with context:

IEnumerable<byte> context = new byte[1024];
using (var stream = StreamBuilder.GetInstance().WithContext(context).BuildMutableStream())
{
    stream.WriteUInt8(0xFF);
}

Same goes for IImmutableStream:

using (var stream = StreamBuilder.GetInstance().BuildImmutableStream())
{
   var foo = stream.ReadUInt8();
}

With one exception, since IImmutableStream needs some kind of context to be provided. context can be provided using WithContext(IEnumerable<byte> context).

IEnumerable<byte> context = new byte[1024];
using (var stream = StreamBuilder.GetInstance().WithContext(context).BuildImmutableStream())
{
    var foo = stream.ReadUInt8();
}

Using MemoryPartitioner:

using (var stream = StreamBuilder.GetInstance().BuildMutableStream())
{
    stream.WriteBytes((IEnumerable<byte>)context);
    var chunks = MemoryPartitioner.GenerateChunks(100, stream);
}

The above code will generate X number of chunks, each up to 100 entries long.

Here a sample benchmarks data for random bytes:

Method Mean Error StdDev Median Completed Work Items Lock Contentions Gen0 Allocated
Partitioner_10_Iterations 324.5 ns 5.31 ns 4.97 ns 323.6 ns - - 0.1097 344 B
Partitioner_10_Iterations_Async 1,728.9 ns 17.24 ns 16.13 ns 1,725.5 ns 1.0222 0.0000 0.2384 744 B
Partitioner_100_Iterations 909.7 ns 4.89 ns 3.82 ns 910.1 ns - - 0.2317 728 B
Partitioner_100_Iterations_Async 2,429.3 ns 21.02 ns 18.63 ns 2,425.9 ns 1.0145 - 0.3624 1128 B
Partitioner_1000_Iterations 6,288.2 ns 120.92 ns 118.76 ns 6,294.8 ns - - 1.1063 3488 B
Partitioner_1000_Iterations_Async 8,732.0 ns 166.67 ns 459.05 ns 8,596.8 ns 1.0056 - 1.2665 3888 B
Product Compatible and additional computed target framework versions.
.NET 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 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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • net6.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.

Version Downloads Last Updated
1.0.0 275 10/3/2022