Funtom.span 0.0.4

Funtom.span

🔷 What's this?

Funtom.span is a library that provides functions related to memory allocation.

🔷 How to use?

1️⃣ Memory module

Memory.stackalloc<'a> size: int → nativeptr<'a>

Allocates a region of memory on the stack.

let span: nativeptr<char> = Memory.stackalloc<char> 256

Memory.stackalloca<'a> size: int → Span<'a>

Allocates a region of memory on the stack and returns value as Span<'a>.

let span: Span<char> = Memory.stackalloca<char> 256

Memory.alloc<'a> size: int → Span<'a>

Allocates a memory area on the stack or heap according to the specified size and returns the value as Span<'a>. The threshold can be changed under Memory.threshold.

Memory.threshold <- 256
let span: Span<char> = Memory.alloc<char> 256

Memory.ref<'a> span: Span<'a> → byref<'a>

Returns a reference to the element of the span at index 0.

let span: Span<char> = Memory.stackalloca<char> 256
let r: byref<char> = Memory.ref span

Memory.rent<'a> size: int → array<'a>

Retrieves a buffer that is at least the requested length.

let buf: array<char> = Memory.rent<char> 256

Memory.returns<'a> buffer: array<'a> → unit

Returns an array to the pool that was previously obtained using the Memory.rent<'a> method on the same System.Buffers.ArrayPool instance.

let buf: array<char> = Memory.rent<char> 256
Memory.returns buf

2️⃣ SpanExtensions

This extension to allow Span<'a> to be F# sliced.

let span: Span<char> = Memory.stackalloca<char> 256
let sliced: Span<char> = span[..128]