Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion quest/m2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ The fork's feature quests folded into the [exporter](/quest/m1/ffi-export.md);

- [MIR's codec as fast as THIR's](/quest/m2/ts-mir-codec.md) - the codec from MIR no slower than from THIR in any engine
- [Lower bodies from MIR](/quest/m2/ts-mir.md) - the MIR spike's prototype becomes the only lowering, and the THIR one goes
- [Stable names](/quest/m2/ts-stable-names.md) - generic instances and trait-impl methods always carry their suffix, so callers' names never shift
- [Struct update on a std range](/quest/m2/ts-range-update.md) - `Range { start, ..r }` reads its base, or is refused with a span, instead of dropping it or panicking the driver
- [Cheaper byte slices](/quest/m2/ts-byte-views.md) - splitting a `&[u8]` stops making a `Uint8Array` view per split
- [Wide-integer fast paths](/quest/m2/ts-wide-fast.md) - a fused `from_halves` and an unboxed limb product, kept only if measured faster
Expand Down
21 changes: 0 additions & 21 deletions quest/m2/ts-stable-names.md

This file was deleted.

10 changes: 8 additions & 2 deletions ts/MIGRATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,14 @@
`import * as Decoder from "./coding/decode.Decoder.ts"`, and name the type
`Decoder.Decoder`.
- A function of a type takes `self` first: `dec.slice(4)` is `Decoder.slice(dec, 4)`,
`group.encode(w, v)` is `Group.encode(group, w, v)`, and `Decoder.new(buf, form)`
keeps its spelling, from the type's module.
`group.encode(w, v)` is `Group.encode$Encode_Version(group, w, v)`, and
`Decoder.new(buf, form)` keeps its spelling, from the type's module.
- An enum's functions move from its companion object to its module:
`DecodeError.fmt$Display(err, f)` keeps its spelling, after
`import * as DecodeError from "./coding/decode.DecodeError.ts"`.
- A function's suffix no longer depends on what else is reached. A trait impl's function
always names its trait, with the trait's type arguments, and a generic instance or a
function of a generic type always names its type arguments: `Log.clone` is
`Log.clone$Clone`, `Version.encode` is `Version.encode$Encode_Version`, and
`Wrap.fmt$Pair` is `Wrap.fmt$Debug_Pair`. A closure type in a suffix is named for where
it is defined, `decode_closure0`.
17 changes: 11 additions & 6 deletions ts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,10 +119,15 @@ std's adaptors through `rt.iter.from`. A caller calls `next()` for one item, or
an `rt.Iter` with `for ... of`.

Functions and members are camelCase. Functions are monomorphized: each instance is its
own function, and instances that share a name are suffixed by type, as in
`roundtripLite$Group` or `Wrap.get$Wrap_Pair`. Types are translated once, generically, so
a function of a generic type is one instance's, declaring the instance it takes as
`self`: `fmt$Pair(self: Wrap<Pair.Pair>, f: rt.Formatter)`. A type's module exports the
own function, suffixed after a `$` by its trait, then by its type's type arguments and
its own, as in `roundtripLite$Group`, `Wrap.get$Wrap_Pair`, `Pair.fmt$Debug`, and
`DecodeError.from$From_BoundsExceeded`. The suffix is there even when no other instance
is, so reaching one renames nothing. A closure type goes by where it is defined,
`methods_closure1` for `methods::{closure#1}`, and instances whose suffixes still match,
such as of two types of one name, are numbered `$2` on in the order of their full type
arguments. Types are translated once, generically, so a function of a generic type is one
instance's, declaring the instance it takes as `self`:
`fmt$Debug_Pair(self: Wrap<Pair.Pair>, f: rt.Formatter)`. A type's module exports the
type by its own name, which a caller writes `Decoder.Decoder`, and a function whose name
and exports it as its own: `function new_` is `Decoder.new`. A `Copy` struct, tuple, or
array, or an `Option` or `Result` holding one, is copied where Rust copies it, since JS
Expand All @@ -144,8 +149,8 @@ microtask and yielding to a macrotask after 128 polls.
A file's items follow the Rust source, whatever
order translation reaches them in, so adding a root moves nothing it does not reach.
What a macro makes sits where the macro is called. The instances of one function sit
together, sorted by their suffix (`Pair` in `fmt$Pair`) and then by their full type
arguments.
together, sorted by their suffix (`Debug_Pair` in `fmt$Debug_Pair`) and then by their
full type arguments.

Imports name the `.ts` file, which Node, Bun, and bundlers run as is. A `tsc` build sets
`rewriteRelativeImportExtensions`, or `allowImportingTsExtensions` with `noEmit`.
Expand Down
10 changes: 5 additions & 5 deletions ts/fixtures/codec/expected/bench.ts
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ export function encodeFrames(data: Uint8Array, version: Version.Version, out: rt
const [keyEvery, data6] = takeU64(data5);
const [keySize, ] = takeU64(data6);
const [delta2, keyEvery2] = [rt.i64.cast(delta), rt.u64.low(keyEvery)] as [rt.i64, rt.usize];
let w: Encoder.Encoder = Encoder.new(out, Form.from(version));
let w: Encoder.Encoder = Encoder.new(out, Form.from$From_Version(version));
const end = rt.u64.low(count);
for (let n = 0; n < end; n++) {
let value: [rt.i64, rt.u64];
Expand Down Expand Up @@ -137,7 +137,7 @@ export function encodeFrames(data: Uint8Array, version: Version.Version, out: rt

/** Every FRAME header on the wire: how many, their total size, and the last delta. */
export function decodeFrames(wire: Uint8Array, version: Version.Version, out: rt.ByteVec): rt.Result<undefined, DecodeError.DecodeError> {
let r: Decoder.Decoder = Decoder.new(wire, Form.from(version));
let r: Decoder.Decoder = Decoder.new(wire, Form.from$From_Version(version));
let count: rt.usize = 0;
let total: rt.u64 = 0;
let last: rt.i64 = 0;
Expand Down Expand Up @@ -179,7 +179,7 @@ export function decodeSplit(data: Uint8Array, version: Version.Version, out: rt.
while (end < wire.length) {
end = rt.min(wire.length, rt.usize.add(end, read2));
while (start < end) {
let r: Decoder.Decoder = Decoder.new(rt.slice.range(wire, start, end), Form.from(version));
let r: Decoder.Decoder = Decoder.new(rt.slice.range(wire, start, end), Form.from$From_Version(version));
const frameHeader_ = frameHeader(r);
if (frameHeader_.ok) {
const delta = frameHeader_.value[0];
Expand Down Expand Up @@ -227,7 +227,7 @@ export function encodeGroup(data: Uint8Array, version: Version.Version, out: rt.
const [subscribe, data2] = takeU64(data);
const [sequence, ] = takeU64(data2);
const group = { subscribe, sequence, frameStart: 0 };
return Group.encode(group, Encoder.new(out, Form.from(version)), version);
return Group.encode$Encode_Version(group, Encoder.new(out, Form.from$From_Version(version)), version);
}

/**
Expand Down Expand Up @@ -283,7 +283,7 @@ export function iterate(chain: rt.u8, data: Uint8Array, out: rt.ByteVec): void {
}

export function decodeGroup(wire: Uint8Array, version: Version.Version, out: rt.ByteVec): rt.Result<undefined, DecodeError.DecodeError> {
const decodeSlice = Group.decodeSlice(wire, version);
const decodeSlice = Group.decodeSlice$Decode_Version(wire, version);
if (!decodeSlice.ok) {
return rt.Err(decodeSlice.error);
}
Expand Down
4 changes: 2 additions & 2 deletions ts/fixtures/codec/expected/coding/decode.DecodeError.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ export function fmt$Display(self: DecodeError, __formatter: rt.Formatter): rt.Re
}
}

export function from$FromUtf8Error(source: rt.FromUtf8Error): DecodeError {
export function from$From_FromUtf8Error(source: rt.FromUtf8Error): DecodeError {
return { tag: "InvalidString", _0: source };
}

Expand Down Expand Up @@ -138,7 +138,7 @@ export function complete(self: DecodeError): DecodeError {
}
}

export function from$BoundsExceeded(_: BoundsExceeded.BoundsExceeded): DecodeError {
export function from$From_BoundsExceeded(_: BoundsExceeded.BoundsExceeded): DecodeError {
return { tag: "BoundsExceeded" };
}

Expand Down
2 changes: 1 addition & 1 deletion ts/fixtures/codec/expected/coding/decode.Decoder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ export function string(self: Decoder): rt.Result<string, DecodeError.DecodeError
}
const fromUtf8 = rt.string.fromUtf8(rt.slice.toByteVec(bytes_.value));
if (!fromUtf8.ok) {
return rt.Err(DecodeError.from$FromUtf8Error(fromUtf8.error));
return rt.Err(DecodeError.from$From_FromUtf8Error(fromUtf8.error));
}
return rt.Ok(fromUtf8.value);
}
Expand Down
2 changes: 1 addition & 1 deletion ts/fixtures/codec/expected/coding/encode.EncodeError.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export type EncodeError =
| "Version"
| "Unsupported";

export function from(_: BoundsExceeded.BoundsExceeded): EncodeError {
export function from$From_BoundsExceeded(_: BoundsExceeded.BoundsExceeded): EncodeError {
return "BoundsExceeded";
}

Expand Down
4 changes: 2 additions & 2 deletions ts/fixtures/codec/expected/coding/encode.Encoder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export function bool(self: Encoder, v: boolean): void {
export function varint(self: Encoder, v: rt.u64): rt.Result<undefined, EncodeError.EncodeError> {
const write_ = write(v, self.form, self.buf);
if (!write_.ok) {
return rt.Err(EncodeError.from(write_.error));
return rt.Err(EncodeError.from$From_BoundsExceeded(write_.error));
}
return rt.Ok(write_.value);
}
Expand Down Expand Up @@ -126,7 +126,7 @@ export function fill(self: Encoder, prefix: Prefix.Prefix): rt.Result<undefined,
} else {
const write_ = write(rt.usize.sub(end, body) as rt.u64, self.form, self.buf);
if (!write_.ok) {
return rt.Err(EncodeError.from(write_.error));
return rt.Err(EncodeError.from$From_BoundsExceeded(write_.error));
}
const len = rt.usize.sub(self.buf.length, end);
if (len === 1) {
Expand Down
2 changes: 1 addition & 1 deletion ts/fixtures/codec/expected/coding/varint.Form.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import type * as Version from "../lite/version.Version.ts";
/** How a protocol version lays out a varint on the wire. */
export type Form = { tag: "Quic" } | { tag: "LeadingOnes"; seven: boolean };

export function from(version: Version.Version): Form {
export function from$From_Version(version: Version.Version): Form {
if (version === "Lite01" || version === "Lite02" || version === "Lite03" || version === "Lite04" || version === "Lite05" || version === "Lite06") {
return { tag: "Quic" };
} else {
Expand Down
6 changes: 3 additions & 3 deletions ts/fixtures/codec/expected/coding/version.Version.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export interface Version {
}

/** Decode the version number. */
export function decode(r: Decoder.Decoder, _: Form.Form): rt.Result<Version, DecodeError.DecodeError> {
export function decode$Decode_Form(r: Decoder.Decoder, _: Form.Form): rt.Result<Version, DecodeError.DecodeError> {
const varint = Decoder.varint(r);
if (!varint.ok) {
return rt.Err(varint.error);
Expand All @@ -23,7 +23,7 @@ export function decode(r: Decoder.Decoder, _: Form.Form): rt.Result<Version, Dec
}

/** Encode the value to the given encoder, which may hold partial output on error. */
export function encode$Form(self: Version, w: Encoder.Encoder, _: Form.Form): rt.Result<undefined, EncodeError.EncodeError> {
export function encode$Encode_Form(self: Version, w: Encoder.Encoder, _: Form.Form): rt.Result<undefined, EncodeError.EncodeError> {
const varint = Encoder.varint(w, self._0);
if (!varint.ok) {
return rt.Err(varint.error);
Expand All @@ -32,7 +32,7 @@ export function encode$Form(self: Version, w: Encoder.Encoder, _: Form.Form): rt
}

/** Encode the value to the given encoder, which may hold partial output on error. */
export function encode$Version(self: Version, w: Encoder.Encoder, _: version_Version.Version): rt.Result<undefined, EncodeError.EncodeError> {
export function encode$Encode_Version(self: Version, w: Encoder.Encoder, _: version_Version.Version): rt.Result<undefined, EncodeError.EncodeError> {
const varint = Encoder.varint(w, self._0);
if (!varint.ok) {
return rt.Err(varint.error);
Expand Down
30 changes: 15 additions & 15 deletions ts/fixtures/codec/expected/coding/version.Versions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ import * as Version from "../coding/version.Version.ts";
import type * as version_Version from "../lite/version.Version.ts";

/** Decode the value from the front of `buf`, returning it and the bytes it took. */
export function decodeSlice(buf: Uint8Array, version: Form.Form): rt.Result<[Versions, rt.usize], DecodeError.DecodeError> {
export function decodeSlice$Decode_Form(buf: Uint8Array, version: Form.Form): rt.Result<[Versions, rt.usize], DecodeError.DecodeError> {
let r: Decoder.Decoder = Decoder.new(buf, version);
const decode_ = decode(r, version);
if (!decode_.ok) {
return rt.Err(decode_.error);
const decode = decode$Decode_Form(r, version);
if (!decode.ok) {
return rt.Err(decode.error);
}
const value = decode_.value;
const value = decode.value;
return rt.Ok([value, rt.usize.sub(buf.length, Decoder.remaining(r))]);
}

Expand All @@ -26,7 +26,7 @@ export interface Versions {
}

/** Decode the version list. */
export function decode(r: Decoder.Decoder, version: Form.Form): rt.Result<Versions, DecodeError.DecodeError> {
export function decode$Decode_Form(r: Decoder.Decoder, version: Form.Form): rt.Result<Versions, DecodeError.DecodeError> {
const varint = Decoder.varint(r);
if (!varint.ok) {
return rt.Err(varint.error);
Expand All @@ -35,24 +35,24 @@ export function decode(r: Decoder.Decoder, version: Form.Form): rt.Result<Versio
let vs: Version.Version[] = [];
const end = count;
for (const _ of new rt.Range(0, end, rt.u64)) {
const decode_ = Version.decode(r, version);
if (!decode_.ok) {
return rt.Err(decode_.error);
const decode = Version.decode$Decode_Form(r, version);
if (!decode.ok) {
return rt.Err(decode.error);
}
const v = decode_.value;
const v = decode.value;
vs.push(rt.copy(v));
}
return rt.Ok({ _0: vs });
}

/** Encode the version list. */
export function encode$Form(self: Versions, w: Encoder.Encoder, version: Form.Form): rt.Result<undefined, EncodeError.EncodeError> {
export function encode$Encode_Form(self: Versions, w: Encoder.Encoder, version: Form.Form): rt.Result<undefined, EncodeError.EncodeError> {
const varint = Encoder.varint(w, self._0.length as rt.u64);
if (!varint.ok) {
return rt.Err(varint.error);
}
for (const v of self._0) {
const encode = Version.encode$Form(v, w, version);
const encode = Version.encode$Encode_Form(v, w, version);
if (!encode.ok) {
return rt.Err(encode.error);
}
Expand All @@ -61,21 +61,21 @@ export function encode$Form(self: Versions, w: Encoder.Encoder, version: Form.Fo
}

/** Encode the version list. */
export function encode$Version(self: Versions, w: Encoder.Encoder, version: version_Version.Version): rt.Result<undefined, EncodeError.EncodeError> {
export function encode$Encode_Version(self: Versions, w: Encoder.Encoder, version: version_Version.Version): rt.Result<undefined, EncodeError.EncodeError> {
const varint = Encoder.varint(w, self._0.length as rt.u64);
if (!varint.ok) {
return rt.Err(varint.error);
}
for (const v of self._0) {
const encode = Version.encode$Version(v, w, version);
const encode = Version.encode$Encode_Version(v, w, version);
if (!encode.ok) {
return rt.Err(encode.error);
}
}
return rt.Ok(undefined);
}

export function from(vs: Version.Version[]): Versions {
export function from$From_Versions(vs: Version.Version[]): Versions {
return { _0: rt.slice.toVec(vs) };
}

Expand Down
Loading