Module: nupp.span

ByteSpanrecord#

A checked, shared view over contiguous elements.

local record ByteSpan
    readonly anchor: any
    readonly pointer: uint8[?] borrows anchor
    readonly offset: integer
    readonly count: integer
end

Fields

ByteWriteSpanrecord#

An affine checked write range. Its live token keeps the source under an incompatible-borrow barrier until commit or scope exit consumes it.

local record ByteWriteSpan
    readonly anchor: any
    readonly pointer: uint8[?] borrows anchor
    readonly offset: integer
    readonly count: integer

    @drop
    function commit(takes self: ByteWriteSpan): nil
    end

    function set(self: ByteWriteSpan, index: integer, value: uint8): nil
    end
end

Methods

commit: function commit(takes self: ByteWriteSpan): nil

set: function set(self: ByteWriteSpan, index: integer, value: uint8): nil

Fields

ByteSpan:getmethod#

Returns one byte after checking the one-based index.

function ByteSpan:get(index: integer): uint8

Arguments

Returns

Raises

• when index is outside 1 through count

ByteSpan:slicemethod#

Returns a checked subspan, inclusive at both ends.

function ByteSpan:slice(first: integer, last: integer?): ByteSpan borrows self

Arguments

Returns

Raises

• when the requested range is outside this span

span.from_carrayfunction#

Creates a checked shared span over a C array and an explicit logical count.

function span.from_carray(borrows source: uint8[?], count: integer): ByteSpan borrows source

Arguments

Returns

Raises

• when count is negative

span.from_stringfunction#

Creates a byte span over a Lua string and keeps that string rooted.

function span.from_string(borrows source: string): ByteSpan borrows source

Arguments

Returns

span.write_carrayfunction#

Creates an affine write span. The source is exclusive during construction and the returned dependent owner prevents invalidating operations until it is committed.

function span.write_carray(exclusive source: uint8[?], count: integer): ByteWriteSpan borrows source

Arguments

Returns

Raises

• when count is negative