Narra

Reference

std/channel

std/channel

Bounded channels between threads.

narra
import * as Channel from "std/channel"

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/channel. Do not edit it.

Types

Sender

narra
export opaque struct Sender<T>

Functions: create, send, close.

Receiver

narra
export opaque struct Receiver<T>

Functions: create, receive, values.

Functions

create

narra
export function create<T>(capacity: int): #[Sender<T>, Receiver<T>] uses alloc

Effects: alloc.

send

narra
export function send<T>(sender: Sender<T>, value: T): bool uses io

Effects: io.

receive

narra
export function receive<T>(receiver: Receiver<T>): Option<T> uses io

Effects: io.

values

narra
export function* values<T>(receiver: Receiver<T>): Generator<T> uses io

Effects: io.

close

narra
export function close<T>(sender: Sender<T>)

Effects: none.