Introduction

This library contains various general purpose helpers, utilities and extensions.

Redistribution

The library is redistributed as NuGet package: Amarok.Shared

The package provides strong-named binaries for .NET Standard 2.0, .NET 6.0, .NET 8.0, and .NET 9.0. Tests are performed with .NET Framework 4.8, .NET 6.0, .NET 8.0, and .NET 9.0.

Types of Interest

BufferSpan

A memory-efficient value type pointing to a span (segment) in a byte array. Provides APIs for appending or slicing. Tuned to reduce memory allocations.

var a = BufferSpan.From(0x11, 0x22);
var b = BufferSpan.From(new Byte[] { 0x22, 0x33, 0x44, 0x55, 0x66 }, 1, 3);

b.Buffer      // 0x22, 0x33, 0x44, 0x55, 0x66; same as supplied to From(..)
b.Offset      // 1
b.Count       // 3
b.IsEmpty     // false
b.ToArray()   // 0x33, 0x44, 0x55; allocates new byte array
b.ToString()  // 33-44-55

var c = a.Append(b);    // 0x11, 0x22, 0x33, 0x44, 0x55; re-uses byte array if big enough,
                        //                               otherwise allocates new byte array
c = c.Discard(1);       // 0x22, 0x33, 0x44, 0x55; re-uses byte array
c = c.Slice(1, 2);      // 0x33, 0x44; re-uses byte array
c = c.Clear();          // <empty>, but re-uses the original byte array

Byte, Byte[] Extensions

Extension methods for efficient hex formatting.

Byte byte = 0x0F;
String text = byte.ToHex();       // "0x0F"

Byte[] bytes = new[] { 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77, 0x88, 0x99, 0xAA };
String text = bytes.ToHex(" ");   // "0x11 0x22 0x33 0x44 0x55 0x66 0x77 0x88  0x99 0xAA"

StopwatchPool

Provides a pool of pre-instantiated Stopwatch instances.

Stopwatch sw = null;
try
{
  sw = StopwatchPool.Rent();

  // use stop watch
}
finally
{
  StopwatchPool.Free(sw);
}

StringBuilderPool

Provides a pool of pre-instantiated StringBuilder instances.

StringBuilder sb = null;
try
{
  sb = StringBuilderPool.Rent();

  // use string builder

  var result = sb.ToString();
}
finally
{
  StringBuilderPool.Free(sb);
}