Narra

Reference

std/shared

std/shared

Shared<T>, a value guarded by a lock.

narra
import * as Shared from "std/shared"

The guide teaches it in chapter 15, Threads and shared state.

This page is generated by scripts/std/generate.nra from narrac query --json interface std/shared. Do not edit it.

Types

Shared

narra
export opaque struct Shared<T>

Functions: create, get, set, update, read.

Functions

create

narra
export function create<T>(value: T): Shared<T> uses alloc

Effects: alloc.

get

narra
export function get<T>(shared: Shared<T>): T from shared

Effects: none.

set

narra
export function set<T>(shared: Shared<T>, value: T)

Effects: none.

update

narra
export function update<T, effect E>(shared: Shared<T>, change: (T) => T uses E) uses E

Effects: E.

read

narra
export function read<T, U, effect E>(shared: Shared<T>, look: (value: T) => U from value uses E): U from shared uses E

Effects: E.