3.9 KiB
lib/ — Hare-shaped standard library.
Scope: every lib/* directory except lib/ww/, which is the compiler
frontend port and has its own rules (see lib/ww/CLAUDE.md).
Names mirror Hare. Before adding a function, find its counterpart in
ref/hare/<module>/ and copy the name — drop Hare's underscores per
plan 9 style (trim_prefix → trimprefix, next_token → nexttoken).
Don't invent. Don't shorten further. Don't reorder parameters.
Signatures mirror Hare too, modulo:
-
Tagged-union returns are spelled with the ww
!error tag where Hare uses!void/!T, and indices use the underlying length type (i32under root CLAUDE.md rule 9). Example:strconv.stoi64(s: str, b: strconv.base) (i64 | invalid | overflow)— same shape as Hare's. The base parameter is the named enumstrconv.base(Hare usesenum uint; we pickenum i32to match the index type). -
Static-buffer
strreturns where Hare uses them.strconv.*tosreturns aconst strview into a module-level buffer that is overwritten on the next call to the same function. Callers that need the bytes to outlive the next call duplicate via strings.dup. Functions that genuinely allocate a fresh buffer (strings.dup,strings.concat) still return an ownedstrthat callers free viaos.free(r.ptr, r.len: u64). -
Call-site variadic sugar matches Hare.
fn f(args: T...)declares a Hare-style variadic; call sites either gather N args into a fresh[]T(fmt.println(42, "hi", true)) or forward an existing slice withxs...(fprintln(h, args...)). The bareT...form in tagged unions still means spread-flatten ((...inner | E)); the two uses don't overlap becauseT...only attaches to a param decl.lib/fmtships both the print family (print/println/fprint/fprintln) and the {n}-placeholder family (printf/fprintf/bsprintf/fatalf); the%-parametric modifier form is parsed but its*modsarg slot aborts on dispatch. -
(T | U)sum-typed parameters dispatch viamatchinside the callee.strings.byteindex(haystack: str, needle: (str | rune)),bytes.index(s: []u8, needle: (u8 | []u8)), andrbyteindex/rindexfollow Hare's shape directly. The rune-indexedstrings.index(rune-wise position) isn't shipped yet — we don't have UTF-8 rune iteration in the language stack.
Don't ship a richer surface than Hare has. A documented subset is fine; an extension, rename, or convenience-wrapper is not — callers should not bake the current subset shape into themselves.
Modules with intentional divergence:
lib/osandlib/netstay below the Hare abstraction — they are syscall wrappers, not the high-levelio::handle/net::socketAPI. Use them as the foundation thatlib/ioand the buffered layers build on.lib/osalso plays Hare'ssysrole (ww foldssysintoos), so it is the import floor: lib/os must never import io OR errors — everything points down to os; os's only edge is the import-free time leaf. This is what letserrorsimportos(foros.errno/os.strerror) without a cycle, mirroring Hare'ssys ← errors,sys ← io.lib/iokeeps the ww-specificstreamstruct (vtable of fn pointers, no closures, no methods). The Hareio::handlefamily needs language features we don't have yet.lib/bufioandlib/sortwill be redesigned to Hare'sscanner/cmpfuncshapes; the present minimal forms are placeholders until then.lib/timeandlib/mathship only what callers need today; they're not aiming for parity yet.
When the compiler can express a Hare signature that's still in the
ww-specific shape (e.g., once a module-level *u8 is mutable, the
strconv *tos family graduates to static-buffer returns), graduate
the module in one go — replace the current shape with the Hare shape
and fix the callers. Don't keep both around.