bynk_syntax/ast.rs
1//! Abstract syntax tree types for Bynk v0 (spec §9.2).
2
3use crate::span::Span;
4
5/// An identifier with its source span.
6#[derive(Debug, Clone)]
7pub struct Ident {
8 pub name: String,
9 pub span: Span,
10}
11
12/// Comment trivia attached to a declaration or statement (v1.1 LSP spec
13/// §3.5). The parser collects line comments from the token stream and
14/// attaches them to nearby AST nodes so the formatter can re-emit them.
15///
16/// - `leading` holds comments that appear immediately above the node,
17/// ordered top-to-bottom. Each entry is the body of one `--` line
18/// (the text after the marker, with its original inline whitespace
19/// preserved).
20/// - `trailing` holds a single comment that appears on the same source
21/// line as the node's final token (e.g. `expr -- note`).
22#[derive(Debug, Clone, Default)]
23pub struct Trivia {
24 pub leading: Vec<String>,
25 pub trailing: Option<String>,
26}
27
28impl Trivia {
29 pub fn is_empty(&self) -> bool {
30 self.leading.is_empty() && self.trailing.is_none()
31 }
32}
33
34/// A whole parsed commons source file.
35///
36/// In v0.3 a commons may be split across multiple files in a directory; the
37/// resolver merges them into one logical commons. Each parsed AST instance
38/// represents the contribution from a single source file.
39#[derive(Debug, Clone)]
40pub struct Commons {
41 pub name: QualifiedName,
42 pub items: Vec<CommonsItem>,
43 /// `uses` clauses declared in this file.
44 pub uses: Vec<UsesDecl>,
45 /// Optional documentation block attached to the commons declaration.
46 pub documentation: Option<String>,
47 /// Surface form of the file: brace-delimited body or headerless fragment.
48 pub form: CommonsForm,
49 pub span: Span,
50 /// Trivia attached to the commons declaration itself — leading comments
51 /// before the `commons` keyword and a trailing comment after the header
52 /// or closing brace.
53 pub trivia: Trivia,
54 /// Comments appearing after the last item but before the file ends
55 /// (or the closing brace, for brace form). One entry per `--` line.
56 pub trailing_comments: Vec<String>,
57}
58
59/// The two surface forms in which a commons body may be parsed (v0.3 §3.1).
60#[derive(Debug, Clone, Copy, PartialEq, Eq)]
61pub enum CommonsForm {
62 /// `commons name { ... }`
63 Brace,
64 /// `commons name` followed by top-level declarations to EOF.
65 Fragment,
66}
67
68/// A `uses other.commons` declaration (v0.3 §3.3).
69#[derive(Debug, Clone)]
70pub struct UsesDecl {
71 pub target: QualifiedName,
72 pub span: Span,
73 pub trivia: Trivia,
74}
75
76/// A whole parsed context source file (v0.4 §3.1).
77///
78/// Contexts are the architectural-layer declaration kind. Like commons, a
79/// context may be split across multiple files in a directory.
80#[derive(Debug, Clone)]
81pub struct Context {
82 pub name: QualifiedName,
83 pub items: Vec<CommonsItem>,
84 /// `uses` clauses declared in this file.
85 pub uses: Vec<UsesDecl>,
86 /// `consumes` clauses declared in this file.
87 pub consumes: Vec<ConsumesDecl>,
88 /// `exports` clauses declared in this file.
89 pub exports: Vec<ExportsDecl>,
90 /// Optional documentation block attached to the context declaration.
91 pub documentation: Option<String>,
92 /// Surface form of the file: brace-delimited body or headerless fragment.
93 pub form: CommonsForm,
94 pub span: Span,
95 /// Trivia attached to the context declaration itself — leading comments
96 /// before the `context` keyword.
97 pub trivia: Trivia,
98 /// Comments appearing after the last item but before the file ends
99 /// (or the closing brace, for brace form). One entry per `--` line.
100 pub trailing_comments: Vec<String>,
101}
102
103/// A `consumes other.context` declaration (v0.4 §3.2). May optionally carry
104/// an alias introduced by `consumes other.context as Alias` (v0.6 §3.1).
105#[derive(Debug, Clone)]
106pub struct ConsumesDecl {
107 pub target: QualifiedName,
108 pub alias: Option<Ident>,
109 /// v0.17: `consumes U { Cap, … }` — selected capabilities flattened into
110 /// the consumer's local capability namespace under their bare names (§3.3).
111 /// `None` for the whole-unit forms; `Some` (possibly empty) for the braced
112 /// form. Mutually exclusive with `alias`.
113 pub selected: Option<Vec<Ident>>,
114 pub span: Span,
115 pub trivia: Trivia,
116}
117
118/// An `exports visibility { names }` clause (v0.4 §3.3) or, v0.15, an
119/// `exports capability { names }` clause.
120#[derive(Debug, Clone)]
121pub struct ExportsDecl {
122 pub kind: ExportKind,
123 pub names: Vec<Ident>,
124 pub span: Span,
125 pub trivia: Trivia,
126}
127
128/// What an `exports` clause exposes: types (with a visibility) or, v0.15,
129/// capabilities offered for cross-context consumption.
130#[derive(Debug, Clone, Copy, PartialEq, Eq)]
131pub enum ExportKind {
132 /// `exports opaque { ... }` / `exports transparent { ... }` — type exports.
133 Type(Visibility),
134 /// `exports capability { ... }` — capabilities offered to consumers (v0.15).
135 Capability,
136}
137
138/// Visibility level for an exports clause (v0.4 §3.3).
139#[derive(Debug, Clone, Copy, PartialEq, Eq)]
140pub enum Visibility {
141 /// Token-only outside the context: hold, pass, compare; no inspect, no construct.
142 Opaque,
143 /// Readable shape outside the context: inspect fields, match variants; no construct.
144 Transparent,
145}
146
147/// An `adapter qualified.name { … }` declaration (v0.17 §3.1). An adapter
148/// co-locates a capability contract with a non-Bynk binding: it may declare
149/// capabilities, the boundary types they reference, inline pure helper
150/// `type`/`fn` (and `uses`), external (bodiless) providers, `exports
151/// capability`, and exactly one `binding` clause. It may *not* declare
152/// services, agents, or bodied providers. Like commons/contexts it may be
153/// split across files in a directory.
154#[derive(Debug, Clone)]
155pub struct AdapterDecl {
156 pub name: QualifiedName,
157 pub items: Vec<CommonsItem>,
158 /// `uses` clauses declared in this file (pure-vocabulary mixin; allowed
159 /// because helpers cannot pierce containment — spec [DECISION B]).
160 pub uses: Vec<UsesDecl>,
161 /// `exports capability { … }` clauses (adapters export capabilities and
162 /// boundary types, never services).
163 pub exports: Vec<ExportsDecl>,
164 /// v0.18: `consumes U { Cap, … }` clauses — adapter-to-adapter capability
165 /// dependencies (spec §4.5, \[N\]). Braced form only; adapter targets only
166 /// (both enforced semantically, not in the parser).
167 pub consumes: Vec<ConsumesDecl>,
168 /// The `binding "<module>" requires { … }` clause, if present. Required
169 /// when the adapter declares any external provider (`bynk.adapter.no_binding`).
170 pub binding: Option<BindingDecl>,
171 pub documentation: Option<String>,
172 pub form: CommonsForm,
173 pub span: Span,
174 pub trivia: Trivia,
175 pub trailing_comments: Vec<String>,
176}
177
178/// A `binding "<module>" requires { "pkg": "range", … }` clause inside an
179/// adapter (v0.17 §3.5). `module` is the TypeScript module supplying the
180/// adapter's external provider symbols, resolved relative to the adapter's
181/// source file. `requires` declares npm dependencies folded into the
182/// generated `package.json`.
183#[derive(Debug, Clone)]
184pub struct BindingDecl {
185 /// The module path as written (the string-literal contents, no quotes).
186 pub module: String,
187 pub module_span: Span,
188 pub requires: Vec<RequiresDep>,
189 pub span: Span,
190 pub trivia: Trivia,
191}
192
193/// One `"pkg": "range"` entry in a binding's `requires { … }` map.
194#[derive(Debug, Clone)]
195pub struct RequiresDep {
196 pub package: String,
197 pub range: String,
198 pub span: Span,
199}
200
201/// Either a commons or a context — the two declaration kinds at the file
202/// level (v0.4 §3.1). v0.7 adds the test declaration kind; v0.17 the adapter.
203#[derive(Debug, Clone)]
204pub enum SourceUnit {
205 Commons(Commons),
206 Context(Context),
207 Suite(SuiteDecl),
208 /// v0.17: an `adapter` unit — the host boundary (capability contract +
209 /// external binding).
210 Adapter(AdapterDecl),
211}
212
213impl SourceUnit {
214 pub fn name(&self) -> &QualifiedName {
215 match self {
216 SourceUnit::Commons(c) => &c.name,
217 SourceUnit::Context(c) => &c.name,
218 SourceUnit::Suite(t) => &t.target,
219 SourceUnit::Adapter(a) => &a.name,
220 }
221 }
222
223 pub fn span(&self) -> Span {
224 match self {
225 SourceUnit::Commons(c) => c.span,
226 SourceUnit::Context(c) => c.span,
227 SourceUnit::Suite(t) => t.span,
228 SourceUnit::Adapter(a) => a.span,
229 }
230 }
231
232 pub fn kind_name(&self) -> &'static str {
233 match self {
234 SourceUnit::Commons(_) => "commons",
235 SourceUnit::Context(_) => "context",
236 SourceUnit::Suite(_) => "suite",
237 SourceUnit::Adapter(_) => "adapter",
238 }
239 }
240}
241
242/// A `test <qualified-name> { ... }` declaration (v0.7 §3.1).
243///
244/// A test targets a commons or context by qualified name and bundles a set of
245/// test cases plus optional mock declarations. As with commons and contexts, a
246/// test may be split across multiple files (fragment form).
247#[derive(Debug, Clone)]
248pub struct SuiteDecl {
249 /// The targeted commons or context.
250 pub target: QualifiedName,
251 /// `uses` clauses brought in by this test fragment.
252 pub uses: Vec<UsesDecl>,
253 /// v0.118: suite-scoped `provides` clauses — per-seam provider overrides
254 /// applied to every case (a case-scoped `provides` takes precedence).
255 pub provides: Vec<ProvidesClause>,
256 /// The individual test cases.
257 pub cases: Vec<Case>,
258 /// v0.114: generative `property` blocks (testing track slice 2).
259 pub properties: Vec<PropertyDecl>,
260 /// v0.118: the suite-level tier default (`suite … as integration`). `None`
261 /// means the `unit` default; a `case`'s own tier overrides it. A `property`
262 /// ignores a suite tier (tiers are a `case`-only affordance).
263 pub tier: Option<TestTier>,
264 /// Surface form: brace-delimited body or headerless fragment.
265 pub form: CommonsForm,
266 /// Optional documentation block attached to the test declaration.
267 pub documentation: Option<String>,
268 pub span: Span,
269 pub trivia: Trivia,
270 pub trailing_comments: Vec<String>,
271}
272
273/// v0.118: the tier a `case` runs at (testing track slice 6, ADR 0153). One
274/// body promoted across the testing pyramid; `unit` is the default and elided.
275#[derive(Debug, Clone, Copy, PartialEq, Eq)]
276pub enum TestTier {
277 /// Collaborators stubbed (the default).
278 Unit,
279 /// Real collaborators within one context, no serialisation wire.
280 Integration,
281 /// Contexts wired across the real serialise → JSON → deserialise boundary.
282 System,
283}
284
285impl TestTier {
286 pub fn as_str(self) -> &'static str {
287 match self {
288 TestTier::Unit => "unit",
289 TestTier::Integration => "integration",
290 TestTier::System => "system",
291 }
292 }
293}
294
295/// v0.118: a per-seam provider override `provides Cap.method(<args>) returns <v>
296/// | fails` (testing track slice 6, ADR 0154). Substitutes one capability
297/// method's provision under test; the right-hand side is a value or a fault,
298/// never a computed body.
299#[derive(Debug, Clone)]
300pub struct ProvidesClause {
301 /// The capability being overridden (a consumed seam of the unit).
302 pub capability: Ident,
303 /// The overridden method.
304 pub method: Ident,
305 /// One argument pattern per parameter (`_` or a value the arg must equal).
306 pub args: Vec<ArgPattern>,
307 /// The provision: a value, a fault, or a per-call sequence.
308 pub rhs: ProvidesRhs,
309 pub documentation: Option<String>,
310 pub span: Span,
311 pub trivia: Trivia,
312}
313
314/// v0.118: one argument pattern in a `provides` call pattern. Patterns for the
315/// same method are tried top-to-bottom, first match wins.
316#[derive(Debug, Clone)]
317pub enum ArgPattern {
318 /// `_` — matches any argument.
319 Any(Span),
320 /// A value the recorded argument must equal (a literal or pure value expr).
321 Value(Expr),
322}
323
324/// v0.118: the right-hand side of a `provides` clause.
325#[derive(Debug, Clone)]
326pub enum ProvidesRhs {
327 /// `returns <value>` — a single success value, repeated for every call.
328 Returns(Expr),
329 /// `fails` — inject a capability fault (Principle 3).
330 Fails(Span),
331 /// `returns each [<outcome>, …]` — one outcome per call, in order; the last
332 /// outcome repeats once the sequence is exhausted (DECISION V).
333 ReturnsEach(Vec<SeqOutcome>, Span),
334}
335
336impl ProvidesRhs {
337 pub fn span(&self) -> Span {
338 match self {
339 ProvidesRhs::Returns(e) => e.span,
340 ProvidesRhs::Fails(s) => *s,
341 ProvidesRhs::ReturnsEach(_, s) => *s,
342 }
343 }
344}
345
346/// v0.118: one outcome in a sequenced (`returns each`) `provides`.
347#[derive(Debug, Clone)]
348pub enum SeqOutcome {
349 /// A success value.
350 Value(Expr),
351 /// A fault.
352 Fails(Span),
353}
354
355/// A `case "name" [as <tier>] { [provides …] body }` block inside a suite
356/// (v0.7 §3.3; v0.118 adds the tier clause and case-scoped `provides`).
357#[derive(Debug, Clone)]
358pub struct Case {
359 /// The test name, taken from the string literal.
360 pub name: String,
361 /// The span of the string literal — used for diagnostics and runtime
362 /// failure reports.
363 pub name_span: Span,
364 /// v0.118: the case's own tier, if written (`as integration` / `as system`).
365 /// `None` means inherit the suite default (itself `unit` when unset).
366 pub tier: Option<TestTier>,
367 /// v0.118: case-scoped `provides` clauses (override the suite's, and the
368 /// tier default).
369 pub provides: Vec<ProvidesClause>,
370 pub body: Block,
371 pub documentation: Option<String>,
372 pub span: Span,
373 pub trivia: Trivia,
374}
375
376/// A `property "name" { for all <bindings> [where <pred>] { body } }` block
377/// inside a suite (v0.114, testing track slice 2, ADR 0149). The generative
378/// sibling of [`Case`]: the runner draws inhabitants of each binding's type from
379/// its refinement domain and evaluates the body's `expect`s over them.
380#[derive(Debug, Clone)]
381pub struct PropertyDecl {
382 /// The property name, taken from the string literal.
383 pub name: String,
384 /// The span of the string literal — used for diagnostics and reports.
385 pub name_span: Span,
386 /// The `for all` binder: the generated bindings, an optional `where` filter,
387 /// and the predicate body.
388 pub forall: ForAll,
389 pub documentation: Option<String>,
390 pub span: Span,
391 pub trivia: Trivia,
392}
393
394/// The `for all x: T, … [where <pred>] { … }` binder inside a [`PropertyDecl`].
395#[derive(Debug, Clone)]
396pub struct ForAll {
397 /// The generated bindings, `x: T` (one or more).
398 pub bindings: Vec<ForAllBinding>,
399 /// An optional `where <pred>` filter (a pure `Bool`) applied to generated
400 /// tuples before the body runs.
401 pub where_pred: Option<Expr>,
402 /// The body — one or more statements, typically `expect`s.
403 pub body: Block,
404 pub span: Span,
405}
406
407/// One `for all` binding: `name: T`, where the runner generates inhabitants of
408/// `T` from its refinements.
409#[derive(Debug, Clone)]
410pub struct ForAllBinding {
411 pub name: Ident,
412 pub type_ref: TypeRef,
413}
414
415/// A capability reference in a `given` clause (v0.15 §3.2). A bare name is a
416/// local capability (`given Cap`); a dotted name refers to a capability a
417/// consumed context provides (`given B.Cap` / `given Alias.Cap`).
418#[derive(Debug, Clone)]
419pub struct CapRef {
420 /// `None` for a local capability; `Some(prefix)` for a cross-context
421 /// reference where `prefix` is a consumed-context qualified name or alias.
422 pub context: Option<QualifiedName>,
423 /// The capability's simple name (also the local deps key).
424 pub name: Ident,
425 pub span: Span,
426}
427
428impl CapRef {
429 /// The local deps key / capability simple name (e.g. `Clock`).
430 pub fn key(&self) -> &str {
431 &self.name.name
432 }
433
434 /// True when this references a capability provided by a consumed context.
435 pub fn is_cross_context(&self) -> bool {
436 self.context.is_some()
437 }
438
439 /// The cross-context prefix (consumed-context qualified name or alias) as
440 /// a dotted string, if any.
441 pub fn prefix(&self) -> Option<String> {
442 self.context.as_ref().map(|q| q.joined())
443 }
444}
445
446/// A dotted name like `fitness.units`.
447#[derive(Debug, Clone)]
448pub struct QualifiedName {
449 pub parts: Vec<Ident>,
450 pub span: Span,
451}
452
453impl QualifiedName {
454 pub fn joined(&self) -> String {
455 self.parts
456 .iter()
457 .map(|p| p.name.as_str())
458 .collect::<Vec<_>>()
459 .join(".")
460 }
461}
462
463#[derive(Debug, Clone)]
464pub enum CommonsItem {
465 Type(TypeDecl),
466 Fn(FnDecl),
467 /// `capability Name { fn op(...) -> T ... }` (v0.5; contexts only).
468 Capability(CapabilityDecl),
469 /// `provides Cap = ProviderName { fn op(...) -> T { ... } ... }` (v0.5).
470 Provider(ProviderDecl),
471 /// `service Name { on call(...) -> T { ... } ... }` (v0.5).
472 Service(ServiceDecl),
473 /// `agent Name { key id: T; state { ... }; on call ... }` (v0.5).
474 Agent(AgentDecl),
475 /// `actor Name { auth = Scheme, identity = T }` (v0.45). A nominal boundary
476 /// contract consumed by a handler's `by` clause; not a runnable entity.
477 Actor(ActorDecl),
478}
479
480impl CommonsItem {
481 pub fn name(&self) -> &Ident {
482 match self {
483 CommonsItem::Type(t) => &t.name,
484 CommonsItem::Fn(f) => f.name.ident(),
485 CommonsItem::Capability(c) => &c.name,
486 CommonsItem::Provider(p) => &p.provider_name,
487 CommonsItem::Service(s) => &s.name,
488 CommonsItem::Agent(a) => &a.name,
489 CommonsItem::Actor(a) => &a.name,
490 }
491 }
492}
493
494/// A capability declaration (v0.5 §3.3). Capabilities are interface-like
495/// contracts for external dependencies, used inside contexts. They may only
496/// appear inside a `context` declaration.
497#[derive(Debug, Clone)]
498pub struct CapabilityDecl {
499 pub name: Ident,
500 pub ops: Vec<CapabilityOp>,
501 pub documentation: Option<String>,
502 pub span: Span,
503 pub trivia: Trivia,
504}
505
506/// One operation in a capability (signature only; no body).
507#[derive(Debug, Clone)]
508pub struct CapabilityOp {
509 pub name: Ident,
510 pub params: Vec<Param>,
511 pub return_type: TypeRef,
512 pub documentation: Option<String>,
513 pub span: Span,
514 pub trivia: Trivia,
515}
516
517/// A provider declaration (v0.5 §3.4). Supplies an implementation for a
518/// capability.
519#[derive(Debug, Clone)]
520pub struct ProviderDecl {
521 /// The capability being implemented.
522 pub capability: Ident,
523 /// The provider's identifier (used in tests/config to select impls).
524 pub provider_name: Ident,
525 /// v0.12: capabilities this provider depends on (`provides X = Impl given
526 /// Y, Z { … }`). The provider's operation bodies may use these. v0.15:
527 /// a dependency may be a cross-context capability (`given B.Cap`).
528 pub given: Vec<CapRef>,
529 pub ops: Vec<ProviderOp>,
530 /// v0.17: an *external* provider — `provides Cap = Name` with **no** brace
531 /// block — inside an adapter, supplied by the adapter's binding rather than
532 /// a Bynk body. When `true`, `ops` is empty and the emitter produces no
533 /// class. The absence of the brace block (not an empty one) is the signal.
534 pub external: bool,
535 pub documentation: Option<String>,
536 pub span: Span,
537 pub trivia: Trivia,
538}
539
540/// One operation in a provider (signature plus body).
541#[derive(Debug, Clone)]
542pub struct ProviderOp {
543 pub name: Ident,
544 pub params: Vec<Param>,
545 pub return_type: TypeRef,
546 pub body: Block,
547 pub span: Span,
548 pub trivia: Trivia,
549}
550
551/// A service declaration (v0.5 §3.5). Services are the boundary interface
552/// of a context.
553#[derive(Debug, Clone)]
554pub struct ServiceDecl {
555 pub name: Ident,
556 /// The protocol the service conforms to, from the `from <protocol>` header
557 /// clause (v0.44). `Call` when there is no clause.
558 pub protocol: ServiceProtocol,
559 /// The optional cross-origin (CORS) policy (v0.131, ADR 0159) — a `cors { }`
560 /// section in the service body, only meaningful on a `from http` service.
561 /// `None` when absent (same-origin default, byte-for-byte unchanged output).
562 pub cors: Option<CorsPolicy>,
563 pub handlers: Vec<Handler>,
564 pub documentation: Option<String>,
565 pub span: Span,
566 pub trivia: Trivia,
567}
568
569/// A cross-origin resource-sharing policy on a `from http` service (v0.131,
570/// ADR 0159): the `cors { }` section in the service body. Parsed leniently as a
571/// list of `name: value` fields (the grammar accepts any field name — an unknown
572/// one is a checker diagnostic, per the `@`-annotation precedent, ADR 0111), and
573/// interpreted through the typed accessors below.
574///
575/// `Access-Control-Allow-Methods` is deliberately **not** a field — it is derived
576/// from the service's routes at emit time (the routes already enumerate the
577/// methods; a restated list would drift). Likewise `Allow-Headers` defaults to
578/// `content-type` (+ `Authorization` when a Bearer route exists) and is only
579/// stored here when the author overrides it.
580#[derive(Debug, Clone)]
581pub struct CorsPolicy {
582 /// The `cors { }` fields as written, in source order. Field names are
583 /// validated against the closed set (`origins`/`headers`/`credentials`/
584 /// `maxAge`) by the checker, not the parser.
585 pub fields: Vec<CorsField>,
586 pub span: Span,
587 pub trivia: Trivia,
588}
589
590/// One `name: value` field inside a `cors { }` policy (v0.131).
591#[derive(Debug, Clone)]
592pub struct CorsField {
593 pub name: Ident,
594 pub value: Expr,
595 pub span: Span,
596}
597
598impl CorsPolicy {
599 /// The raw value expression for a field, by name (the last one wins if a
600 /// field is repeated — the checker flags the duplicate separately).
601 pub fn field(&self, name: &str) -> Option<&Expr> {
602 self.fields
603 .iter()
604 .rev()
605 .find(|f| f.name.name == name)
606 .map(|f| &f.value)
607 }
608
609 /// The allowed origins — the string literals of the `origins:` list. An
610 /// absent or malformed field yields an empty list (the checker has already
611 /// reported the shape error; the emitter fails closed on an empty list).
612 pub fn origins(&self) -> Vec<String> {
613 Self::str_list(self.field("origins")).unwrap_or_default()
614 }
615
616 /// `true` iff `origins` is exactly the wildcard `["*"]`.
617 pub fn is_wildcard(&self) -> bool {
618 let os = self.origins();
619 os.len() == 1 && os[0] == "*"
620 }
621
622 /// Whether credentialed requests are allowed (`credentials: true`); defaults
623 /// to `false` when the field is absent.
624 pub fn credentials(&self) -> bool {
625 matches!(
626 self.field("credentials").map(|e| &e.kind),
627 Some(ExprKind::BoolLit(true))
628 )
629 }
630
631 /// The explicit `Access-Control-Allow-Headers` override, if the author gave
632 /// a `headers:` list; `None` leaves the emitter to apply its smart default.
633 pub fn allow_headers(&self) -> Option<Vec<String>> {
634 self.field("headers").and_then(Self::str_list_of)
635 }
636
637 /// The `Access-Control-Max-Age` in whole seconds, if a `maxAge:` duration was
638 /// given; `None` leaves the header off (the browser default).
639 pub fn max_age_secs(&self) -> Option<i64> {
640 match self.field("maxAge").map(|e| &e.kind) {
641 Some(ExprKind::DurationLit { millis, .. }) => Some(millis / 1_000),
642 _ => None,
643 }
644 }
645
646 /// Interpret an expression as a list of string literals, if it is one.
647 fn str_list(expr: Option<&Expr>) -> Option<Vec<String>> {
648 expr.and_then(Self::str_list_of)
649 }
650
651 fn str_list_of(expr: &Expr) -> Option<Vec<String>> {
652 match &expr.kind {
653 ExprKind::ListLit(items) => items
654 .iter()
655 .map(|e| match &e.kind {
656 ExprKind::StrLit(s) => Some(s.clone()),
657 _ => None,
658 })
659 .collect(),
660 _ => None,
661 }
662 }
663}
664
665/// The protocol a service conforms to — declared on the header via
666/// `from <protocol>` (v0.44). `Call` is the default (no `from` clause): a
667/// contract-mediated internal-RPC surface, not a wire protocol. Multi-endpoint
668/// protocols (`Http`, `Cron`) carry no binding — the endpoint lives on each
669/// handler; single-binding `Queue` carries its queue name.
670#[derive(Debug, Clone)]
671pub enum ServiceProtocol {
672 /// No `from` clause: the service holds `on call` handlers only.
673 Call,
674 /// `from http` — many routes; each handler is `on <Method>("route")`.
675 Http,
676 /// `from cron` — many schedules; each handler is `on schedule("expr")`.
677 Cron,
678 /// `from queue("name")` — one bound queue; handlers are `on message(...)`.
679 Queue { name: String },
680 /// `from WebSocket(in: ClientFrame, out: ServerFrame)` — a held WebSocket
681 /// connection (v0.103, real-time track slice 3). `in_type` is the inbound
682 /// frame type (client→server, decoded and routed as typed agent messages);
683 /// `out_type` is the server→client frame type the held `Connection[out_type]`
684 /// carries. The service holds exactly one `on open` handler (edge auth via
685 /// `by`, then transfer of the connection to an agent).
686 WebSocket { in_type: TypeRef, out_type: TypeRef },
687}
688
689/// An agent declaration (v0.5 §3.6). Agents are state-bearing entities
690/// with their own handlers.
691#[derive(Debug, Clone)]
692pub struct AgentDecl {
693 pub name: Ident,
694 /// `key id: Type` — the identifier-typed value identifying instances.
695 pub key_name: Ident,
696 pub key_type: TypeRef,
697 /// `store` fields (v0.81, storage track) — each an access-pattern slot of a
698 /// declared storage kind (`Cell`/`Map`/…). The successor to the removed
699 /// `state { }` record (ADR 0108); every agent declares its state this way.
700 pub store_fields: Vec<StoreField>,
701 /// Invariants (v0.80 §14) — universally-quantified predicates over the
702 /// agent's `store` fields. The phase sits between the fields and the
703 /// handlers; each is checked against the state staged by a handler's writes
704 /// before it commits.
705 pub invariants: Vec<Invariant>,
706 /// Step invariants (v0.116 §, testing track slice 4) — named predicates over
707 /// the pre-/post-commit state *pair* (`old`/`new`), checked at the commit
708 /// boundary beside [`invariants`], from the second commit onward. Widen the
709 /// invariant subject from a snapshot to a step (ADR 0144 — one predicate
710 /// surface).
711 ///
712 /// [`invariants`]: AgentDecl::invariants
713 pub transitions: Vec<Transition>,
714 pub handlers: Vec<Handler>,
715 pub documentation: Option<String>,
716 pub span: Span,
717 pub trivia: Trivia,
718}
719
720/// A `store` field (v0.81, storage track). Each is an access-pattern slot of a
721/// declared storage kind: `store <name>: <Kind>[…] [@annotations] [= <init>]`.
722/// The kind and its element type are carried as an ordinary [`TypeRef`]
723/// (`Cell[Int]`, `Map[K, V]`); the checker restricts which heads are storage
724/// kinds. Access-pattern annotations (`@indexed`, …) parse into [`annotations`]
725/// (v0.85, ADR 0111); the checker validates them against the closed registry.
726///
727/// [`annotations`]: StoreField::annotations
728#[derive(Debug, Clone)]
729pub struct StoreField {
730 pub name: Ident,
731 /// The storage kind and its element type(s): `Cell[Int]`, `Map[K, V]`. A
732 /// dedicated [`StoreKind`] rather than a [`TypeRef`] — storage kinds are not
733 /// value types, and the checker dispatches kind-aware operations on the head.
734 pub kind: StoreKind,
735 /// Storage annotations on the field (v0.85, ADR 0111): `@ttl(5.minutes)`,
736 /// `@indexed(by: orderId)`. Parsed in declaration order (after the kind,
737 /// before the initialiser); the checker validates names against the closed
738 /// registry and gates each to the slice that implements it.
739 pub annotations: Vec<Annotation>,
740 /// The fresh-key initial value (`= expr`), if given — same disposition as a
741 /// `state` field's initialiser (ADRs 0003/0004 carry forward).
742 pub init: Option<Expr>,
743 pub documentation: Option<String>,
744 pub span: Span,
745 pub trivia: Trivia,
746}
747
748/// A storage annotation on a `store` field (v0.85, storage track; ADR 0111):
749/// `@<name>(<args>)`. The `name` is matched against the closed registry
750/// (`@indexed`/`@ttl`/`@retain`/`@bounded`) by the checker; the grammar accepts
751/// any identifier so an unknown name is a checker diagnostic, not a parse error.
752/// Arguments are compile-time metadata, restricted to literals (and the `by:`
753/// field-name labels of `@indexed`) by the checker per ADR 0111 D4.
754#[derive(Debug, Clone)]
755pub struct Annotation {
756 pub name: Ident,
757 pub args: Vec<AnnotationArg>,
758 pub span: Span,
759}
760
761/// A single annotation argument (v0.85; ADR 0111): an optional `label:` followed
762/// by a value expression — `by: orderId` (labelled) or `5.minutes` (positional).
763/// The value is parsed as an ordinary [`Expr`] so the duration-literal form
764/// (`5.minutes`, landing with the `Duration` slice) needs no special grammar;
765/// the checker restricts it to a literal where the annotation is functional.
766#[derive(Debug, Clone)]
767pub struct AnnotationArg {
768 pub label: Option<Ident>,
769 pub value: Expr,
770 pub span: Span,
771}
772
773/// A storage kind applied to its element type(s) (v0.81): `Cell[Int]`,
774/// `Map[ReservationId, Reservation]`. The `head` is the kind name (`Cell`,
775/// `Map`, `Set`, `Log`, `Queue`, `Cache`); the checker validates it against the
776/// closed catalogue. Element types are ordinary [`TypeRef`]s. Refined element
777/// types (`Cell[Int where NonNegative]`) ride a later slice (parse_type_ref does
778/// not yet accept an inline refinement in type-argument position).
779#[derive(Debug, Clone)]
780pub struct StoreKind {
781 pub head: Ident,
782 pub args: Vec<TypeRef>,
783 pub span: Span,
784}
785
786/// An agent invariant (v0.80 §14). A named predicate over the agent's state
787/// fields that must hold of every committed state; a commit that would violate
788/// it faults (`InvariantViolation`) before the state is persisted. The
789/// predicate references state fields by bare name, mirroring the design-notes
790/// worked examples (`status == Paid implies paymentRef.isSome()`).
791#[derive(Debug, Clone)]
792pub struct Invariant {
793 pub name: Ident,
794 /// The predicate expression — an ordinary `Bool`-typed expression over the
795 /// state fields, plus `implies` and `is`. The parsed-predicate-on-a-
796 /// declaration shape mirrors [`ActorRefinement::predicate`].
797 pub predicate: Expr,
798 pub documentation: Option<String>,
799 pub span: Span,
800 pub trivia: Trivia,
801}
802
803/// An agent step invariant (v0.116 §, testing track slice 4). A named predicate
804/// over the *pair* of committed states — the pre-commit `old` and the proposed
805/// `new`, each the agent's state record — that must hold of every state move; a
806/// commit that would violate it faults (`InvariantViolation`) before the state is
807/// persisted, exactly as a snapshot [`Invariant`] does. Widens the invariant
808/// subject from a snapshot to a step (ADR 0144 — one predicate surface); the
809/// predicate reuses the invariant surface (`implies`/`is`/pure methods) with
810/// `old`/`new` bound contextually (`old.status is Paid implies new.status is
811/// Paid`).
812#[derive(Debug, Clone)]
813pub struct Transition {
814 pub name: Ident,
815 /// The predicate expression — an ordinary `Bool`-typed expression over the
816 /// `old` and `new` state records, with `implies`/`is` and pure methods,
817 /// mirroring [`Invariant`].
818 pub predicate: Expr,
819 pub documentation: Option<String>,
820 pub span: Span,
821 pub trivia: Trivia,
822}
823
824/// A function contract clause (v0.115 §, testing track slice 3). A named
825/// predicate on a `fn` signature — a `requires` (precondition) or `ensures`
826/// (postcondition). A contract is the invariant predicate attached to a
827/// function (ADR 0144 — one predicate surface): the predicate is a pure `Bool`
828/// expression over the parameters (`requires`) or the parameters plus `result`
829/// (`ensures`), with `implies`/`is` and pure methods, mirroring [`Invariant`].
830/// The name rides the failure report and the redundant-test dedup.
831#[derive(Debug, Clone)]
832pub struct Contract {
833 pub name: Ident,
834 /// The predicate expression — an ordinary `Bool`-typed expression over the
835 /// parameters (and, for an `ensures`, the contextual `result` binding).
836 pub predicate: Expr,
837 pub span: Span,
838}
839
840/// An actor declaration (v0.45 §3.7). An actor is a nominal *contract type*
841/// describing an external party at a boundary — not a runnable entity. A
842/// handler consumes an actor on its `by` clause; the boundary verifies the
843/// declared `auth` scheme and mints a sealed identity (`name.identity`).
844#[derive(Debug, Clone)]
845pub struct ActorDecl {
846 pub name: Ident,
847 /// The authentication scheme from `auth = <Scheme>`, stored as the raw
848 /// identifier. The checker classifies it: `None`/`Internal`/`Bearer` are
849 /// admitted; `Signature` is reserved-and-rejected
850 /// (`bynk.actor.scheme_unsupported`); anything else is
851 /// `bynk.actor.unknown_scheme`. `None` for the refinement form.
852 pub auth: Option<Ident>,
853 /// The scheme's keyed config from `auth = Scheme(key = value, …)` (v0.47
854 /// `Bearer(secret = "…")`; v0.51 generalised for `Signature(secret, header,
855 /// timestamp?, tolerance?)`). Empty for schemes/forms with no config. The
856 /// checker validates which keys each scheme requires/allows.
857 pub auth_config: Vec<SchemeArg>,
858 /// The optional identity type from `, identity = <T>`. Absent ⇒ the
859 /// scheme default (`()` for `None`; a sealed `CallerId` for the `Internal`
860 /// `on call` channel, `()` for other `Internal` channels).
861 pub identity: Option<TypeRef>,
862 /// The reserved-and-rejected refinement form `actor Admin = Base where p`
863 /// (Q3). Parsed so the grammar is fixed now; the checker emits
864 /// `bynk.actor.refinement_unsupported`.
865 pub refinement: Option<ActorRefinement>,
866 pub documentation: Option<String>,
867 pub span: Span,
868 pub trivia: Trivia,
869}
870
871impl ActorDecl {
872 /// The value of a scheme config arg by key, if present (e.g. `secret`,
873 /// `header`).
874 pub fn scheme_arg(&self, key: &str) -> Option<&SchemeArg> {
875 self.auth_config.iter().find(|a| a.key.name == key)
876 }
877}
878
879/// One `key = value` argument in a scheme config (`Scheme(key = value, …)`).
880#[derive(Debug, Clone)]
881pub struct SchemeArg {
882 pub key: Ident,
883 pub value: SchemeArgValue,
884 /// Span of the value, for diagnostics.
885 pub span: Span,
886}
887
888/// A scheme config arg value — a string literal or an integer.
889#[derive(Debug, Clone)]
890pub enum SchemeArgValue {
891 Str(String),
892 Int(i64),
893}
894
895impl SchemeArgValue {
896 pub fn as_str(&self) -> Option<&str> {
897 match self {
898 SchemeArgValue::Str(s) => Some(s),
899 SchemeArgValue::Int(_) => None,
900 }
901 }
902 pub fn as_int(&self) -> Option<i64> {
903 match self {
904 SchemeArgValue::Int(n) => Some(*n),
905 SchemeArgValue::Str(_) => None,
906 }
907 }
908}
909
910/// The reserved refinement form `actor Admin = User where <predicate>` (Q3).
911/// Parsed in Foundations so the grammar is fixed; admission is a later slice.
912#[derive(Debug, Clone)]
913pub struct ActorRefinement {
914 /// The base actor being refined.
915 pub base: Ident,
916 /// The `where` predicate. Parsed but not yet checked.
917 pub predicate: Expr,
918 pub span: Span,
919}
920
921/// The `by (<binder>:)? <Actor>` clause on a handler (v0.45; binder optional in
922/// v0.50). Names the actor contract the handler consumes; when a `binder` is
923/// given, the verified identity binds to it and is read as `binder.identity`.
924/// Omitting the binder (`by <Actor>`) declares-and-verifies the contract without
925/// capturing the identity — for anonymous or verify-and-discard handlers. Sits
926/// after the protocol config and before the parameters.
927#[derive(Debug, Clone)]
928pub struct ByClause {
929 /// The identity binder, if the handler consumes the identity. `None` for the
930 /// binder-less `by <Actor>` form. Required when `actors` names more than one
931 /// (a sum is resolved by matching on the bound actor).
932 pub binder: Option<Ident>,
933 /// The actor contract(s) referenced — each a local actor decl or a prelude
934 /// actor. A single name is the ordinary single-actor handler; more than one
935 /// (`by who: A | B`, v0.52) is an **ordered sum of peer actors** resolved
936 /// first-wins, the body matching on the resolved actor. Always non-empty.
937 pub actors: Vec<Ident>,
938 pub span: Span,
939}
940
941impl ByClause {
942 /// The first (and, for a single-actor handler, only) actor contract named.
943 pub fn primary(&self) -> &Ident {
944 &self.actors[0]
945 }
946 /// Whether this `by` clause names an ordered sum of peer actors (`A | B`).
947 pub fn is_sum(&self) -> bool {
948 self.actors.len() > 1
949 }
950}
951
952/// A handler block — `on call(args) -> T given C1, C2 { body }`.
953/// Used by both services and agents.
954#[derive(Debug, Clone)]
955pub struct Handler {
956 pub kind: HandlerKind,
957 /// Handler-position annotations (v0.140, ADR 0163): `@cache(maxAge: 5.minutes)`
958 /// written immediately before `on <METHOD>(…)`. Reuses the [`Annotation`] AST
959 /// shared with `store` fields (ADR 0111); the grammar accepts any `@name(args)`
960 /// so an unknown name is a project-validation diagnostic, not a parse error. The
961 /// first handler-position annotation surface — empty for every handler that
962 /// carries none.
963 pub annotations: Vec<Annotation>,
964 /// For agent handlers, the method-style handler name (e.g.
965 /// `on call addItem(...)`). For service handlers, this is None (just
966 /// `on call(...)`).
967 pub method_name: Option<Ident>,
968 /// The `by <binder>: <Actor>` clause (v0.45), if present. Service handlers
969 /// only; an absent clause inherits the protocol's default actor.
970 pub by_clause: Option<ByClause>,
971 pub params: Vec<Param>,
972 pub return_type: TypeRef,
973 pub given: Vec<CapRef>,
974 pub body: Block,
975 pub documentation: Option<String>,
976 pub span: Span,
977 pub trivia: Trivia,
978}
979
980#[derive(Debug, Clone, PartialEq, Eq)]
981pub enum HandlerKind {
982 /// `on call(...)` — typed RPC (the only kind in v0.5).
983 Call,
984 /// `on http METHOD "path"` — external-facing HTTP route (v0.9).
985 Http { method: HttpMethod, path: String },
986 /// `on cron "expr"` — scheduled task; `expr` is a 5-field cron
987 /// expression (v0.10a).
988 Cron { expr: String },
989 /// `on message(m: T)` — a message off the service's bound queue. The queue
990 /// binding lives on the service's `ServiceProtocol::Queue` (v0.44).
991 Message,
992 /// `on open ...` — the WebSocket upgrade handler (v0.103, real-time track
993 /// slice 3). Exactly one per `from WebSocket` service; carries a mandatory
994 /// `by` clause (edge auth) and receives a fresh owned `Connection[out]`.
995 Open,
996 /// `on close ...` — the WebSocket close handler (v0.106, real-time track slice
997 /// 3b-iii). Optional, ≤1 per `from WebSocket` service; runs when the socket
998 /// closes. Like `on open`, edge-authenticated (`by`), with the identity/params
999 /// recovered from the socket attachment (set at `on open`). (A `from WebSocket`
1000 /// `on message` reuses [`HandlerKind::Message`], disambiguated by the protocol.)
1001 Close,
1002}
1003
1004/// HTTP methods supported by `on http` handlers (v0.9).
1005#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1006pub enum HttpMethod {
1007 Get,
1008 Post,
1009 Put,
1010 Patch,
1011 Delete,
1012}
1013
1014impl HttpMethod {
1015 pub fn as_str(self) -> &'static str {
1016 match self {
1017 HttpMethod::Get => "GET",
1018 HttpMethod::Post => "POST",
1019 HttpMethod::Put => "PUT",
1020 HttpMethod::Patch => "PATCH",
1021 HttpMethod::Delete => "DELETE",
1022 }
1023 }
1024
1025 pub fn from_ident(s: &str) -> Option<HttpMethod> {
1026 match s {
1027 "GET" => Some(HttpMethod::Get),
1028 "POST" => Some(HttpMethod::Post),
1029 "PUT" => Some(HttpMethod::Put),
1030 "PATCH" => Some(HttpMethod::Patch),
1031 "DELETE" => Some(HttpMethod::Delete),
1032 _ => None,
1033 }
1034 }
1035
1036 /// True if this method conventionally has no request body.
1037 pub fn forbids_body(self) -> bool {
1038 matches!(self, HttpMethod::Get | HttpMethod::Delete)
1039 }
1040}
1041
1042/// Payload shape of an `HttpResult[T]` variant (v0.9 §3.3).
1043#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1044pub enum HttpVariantPayload {
1045 /// No payload (e.g. `NoContent`, `Unauthorized`).
1046 None,
1047 /// Carries a value of the `HttpResult` type parameter `T`.
1048 Value,
1049 /// Carries a `String` message (e.g. `BadRequest`, `Conflict`).
1050 Message,
1051 /// Carries a `String` target URL, emitted as a `Location` header — the
1052 /// redirect variants (`Found`, `SeeOther`, `PermanentRedirect`, …).
1053 Location,
1054 /// Carries a `Stream[String]`, emitted as an SSE (`text/event-stream`)
1055 /// streaming body — the `Streaming` (200) variant (v0.101, real-time track
1056 /// slice 1).
1057 Streamed,
1058 /// Carries `(body: Bytes, contentType: String)` — the author-owned raw body
1059 /// written straight into the response with the declared `content-type` and
1060 /// **no codec** (the typed-wire guarantee is deliberately off). The `Raw`
1061 /// (200) variant (v0.111); the first two-argument payload shape.
1062 Raw,
1063}
1064
1065/// One variant of the built-in `HttpResult[T]` sum (v0.9 §3.3).
1066#[derive(Debug, Clone, Copy)]
1067pub struct HttpVariant {
1068 pub name: &'static str,
1069 pub payload: HttpVariantPayload,
1070 pub status: u16,
1071}
1072
1073/// All `HttpResult[T]` variants, in declaration order (ascending status). The
1074/// vocabulary tracks the common, modern HTTP status codes (RFC 9110): success
1075/// and created/accepted (`Value`), redirects carrying a `Location` URL, and
1076/// the client/server failures that handlers routinely return (`Message` when
1077/// an explanation helps the caller, `None` for self-describing statuses).
1078pub const HTTP_VARIANTS: &[HttpVariant] = &[
1079 // ── 2xx success ──────────────────────────────────────────────────────
1080 HttpVariant {
1081 name: "Ok",
1082 payload: HttpVariantPayload::Value,
1083 status: 200,
1084 },
1085 // v0.101 (real-time track slice 1): a 200 whose body is a streamed
1086 // `Stream[String]`, SSE-framed. Status precedes the body, so streaming is
1087 // 200-only — pre-stream failures are ordinary variants returned instead.
1088 HttpVariant {
1089 name: "Streaming",
1090 payload: HttpVariantPayload::Streamed,
1091 status: 200,
1092 },
1093 // v0.111: a 200 whose body is an author-owned `Bytes` written straight into
1094 // the response with the declared `content-type` — no codec runs. 200-only,
1095 // like `Streaming`: it serves service-tier raw bodies (`robots.txt`,
1096 // `sitemap.xml`, feeds, a QR PNG), not custom-status error pages.
1097 HttpVariant {
1098 name: "Raw",
1099 payload: HttpVariantPayload::Raw,
1100 status: 200,
1101 },
1102 HttpVariant {
1103 name: "Created",
1104 payload: HttpVariantPayload::Value,
1105 status: 201,
1106 },
1107 HttpVariant {
1108 name: "Accepted",
1109 payload: HttpVariantPayload::Value,
1110 status: 202,
1111 },
1112 HttpVariant {
1113 name: "NoContent",
1114 payload: HttpVariantPayload::None,
1115 status: 204,
1116 },
1117 // ── 3xx redirection (carry a `Location` URL) ─────────────────────────
1118 HttpVariant {
1119 name: "MovedPermanently",
1120 payload: HttpVariantPayload::Location,
1121 status: 301,
1122 },
1123 HttpVariant {
1124 name: "Found",
1125 payload: HttpVariantPayload::Location,
1126 status: 302,
1127 },
1128 HttpVariant {
1129 name: "SeeOther",
1130 payload: HttpVariantPayload::Location,
1131 status: 303,
1132 },
1133 HttpVariant {
1134 name: "TemporaryRedirect",
1135 payload: HttpVariantPayload::Location,
1136 status: 307,
1137 },
1138 HttpVariant {
1139 name: "PermanentRedirect",
1140 payload: HttpVariantPayload::Location,
1141 status: 308,
1142 },
1143 // ── 4xx client error ─────────────────────────────────────────────────
1144 HttpVariant {
1145 name: "BadRequest",
1146 payload: HttpVariantPayload::Message,
1147 status: 400,
1148 },
1149 HttpVariant {
1150 name: "Unauthorized",
1151 payload: HttpVariantPayload::None,
1152 status: 401,
1153 },
1154 HttpVariant {
1155 name: "Forbidden",
1156 payload: HttpVariantPayload::None,
1157 status: 403,
1158 },
1159 HttpVariant {
1160 name: "NotFound",
1161 payload: HttpVariantPayload::None,
1162 status: 404,
1163 },
1164 HttpVariant {
1165 name: "MethodNotAllowed",
1166 payload: HttpVariantPayload::None,
1167 status: 405,
1168 },
1169 HttpVariant {
1170 name: "NotAcceptable",
1171 payload: HttpVariantPayload::None,
1172 status: 406,
1173 },
1174 HttpVariant {
1175 name: "RequestTimeout",
1176 payload: HttpVariantPayload::None,
1177 status: 408,
1178 },
1179 HttpVariant {
1180 name: "Conflict",
1181 payload: HttpVariantPayload::Message,
1182 status: 409,
1183 },
1184 HttpVariant {
1185 name: "Gone",
1186 payload: HttpVariantPayload::None,
1187 status: 410,
1188 },
1189 HttpVariant {
1190 name: "LengthRequired",
1191 payload: HttpVariantPayload::None,
1192 status: 411,
1193 },
1194 HttpVariant {
1195 name: "PayloadTooLarge",
1196 payload: HttpVariantPayload::Message,
1197 status: 413,
1198 },
1199 HttpVariant {
1200 name: "UnsupportedMediaType",
1201 payload: HttpVariantPayload::Message,
1202 status: 415,
1203 },
1204 HttpVariant {
1205 name: "UnprocessableEntity",
1206 payload: HttpVariantPayload::Message,
1207 status: 422,
1208 },
1209 HttpVariant {
1210 name: "TooManyRequests",
1211 payload: HttpVariantPayload::Message,
1212 status: 429,
1213 },
1214 HttpVariant {
1215 name: "UnavailableForLegalReasons",
1216 payload: HttpVariantPayload::Message,
1217 status: 451,
1218 },
1219 // ── 5xx server error ─────────────────────────────────────────────────
1220 HttpVariant {
1221 name: "ServerError",
1222 payload: HttpVariantPayload::Message,
1223 status: 500,
1224 },
1225 HttpVariant {
1226 name: "NotImplemented",
1227 payload: HttpVariantPayload::Message,
1228 status: 501,
1229 },
1230 HttpVariant {
1231 name: "BadGateway",
1232 payload: HttpVariantPayload::Message,
1233 status: 502,
1234 },
1235 HttpVariant {
1236 name: "ServiceUnavailable",
1237 payload: HttpVariantPayload::Message,
1238 status: 503,
1239 },
1240 HttpVariant {
1241 name: "GatewayTimeout",
1242 payload: HttpVariantPayload::Message,
1243 status: 504,
1244 },
1245];
1246
1247/// Find an `HttpResult[T]` variant by name. Returns the variant info or
1248/// `None` if the name doesn't match.
1249pub fn http_variant(name: &str) -> Option<HttpVariant> {
1250 HTTP_VARIANTS.iter().copied().find(|v| v.name == name)
1251}
1252
1253/// Payload shape of a `QueueResult` variant (v0.44). Non-generic — a verdict
1254/// carries no value; `Retry` carries a `String` reason for the log path.
1255#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1256pub enum QueueVariantPayload {
1257 /// No payload (`Ack`).
1258 None,
1259 /// Carries a `String` reason (`Retry`).
1260 Message,
1261}
1262
1263/// One variant of the built-in `QueueResult` sum (v0.44).
1264#[derive(Debug, Clone, Copy)]
1265pub struct QueueVariant {
1266 pub name: &'static str,
1267 pub payload: QueueVariantPayload,
1268}
1269
1270/// All `QueueResult` variants, in declaration order. `Ack` confirms the
1271/// message; `Retry` redelivers it, carrying a reason for observability.
1272pub const QUEUE_VARIANTS: &[QueueVariant] = &[
1273 QueueVariant {
1274 name: "Ack",
1275 payload: QueueVariantPayload::None,
1276 },
1277 QueueVariant {
1278 name: "Retry",
1279 payload: QueueVariantPayload::Message,
1280 },
1281];
1282
1283/// Find a `QueueResult` variant by name.
1284pub fn queue_variant(name: &str) -> Option<QueueVariant> {
1285 QUEUE_VARIANTS.iter().copied().find(|v| v.name == name)
1286}
1287
1288#[derive(Debug, Clone)]
1289pub struct TypeDecl {
1290 pub name: Ident,
1291 pub body: TypeBody,
1292 /// Documentation block attached to this declaration (v0.3).
1293 pub documentation: Option<String>,
1294 pub span: Span,
1295 pub trivia: Trivia,
1296}
1297
1298/// The right-hand side of a `type` declaration. In v0/v0.1 only the
1299/// `Refined` variant existed; v0.2 adds records and sums; v0.3 adds opaque.
1300#[derive(Debug, Clone)]
1301pub enum TypeBody {
1302 /// Refined base type: `BaseType where refinement`.
1303 Refined {
1304 base: BaseType,
1305 base_span: Span,
1306 refinement: Option<Refinement>,
1307 },
1308 /// Record type: `{ field: T where ..., ... }`.
1309 Record(RecordBody),
1310 /// Sum type: pipe-form variants or `enum { ... }` shorthand.
1311 Sum(SumBody),
1312 /// Opaque base type: `opaque BaseType (where refinement)?` (v0.3 §3.4).
1313 /// Identity is nominal; the base type is hidden outside the defining commons.
1314 Opaque {
1315 base: BaseType,
1316 base_span: Span,
1317 refinement: Option<Refinement>,
1318 },
1319}
1320
1321/// Body of a record-type declaration (v0.2 §3.1).
1322#[derive(Debug, Clone)]
1323pub struct RecordBody {
1324 pub fields: Vec<RecordField>,
1325 pub span: Span,
1326}
1327
1328/// One field of a record type declaration. Each field may carry inline
1329/// refinement, which is enforced at construction time on the field's value.
1330#[derive(Debug, Clone)]
1331pub struct RecordField {
1332 pub name: Ident,
1333 pub type_ref: TypeRef,
1334 pub refinement: Option<Refinement>,
1335 /// v0.11: an optional initial-value expression. Only meaningful on agent
1336 /// `state` fields (the field's fresh-key value); ignored / rejected on
1337 /// record-type fields by the checker.
1338 pub init: Option<Expr>,
1339 pub span: Span,
1340}
1341
1342/// Body of a sum-type declaration (v0.2 §3.2).
1343#[derive(Debug, Clone)]
1344pub struct SumBody {
1345 pub variants: Vec<Variant>,
1346 pub span: Span,
1347}
1348
1349/// One variant of a sum type. Variants may have payload fields; a
1350/// payload-less variant is a simple tag.
1351#[derive(Debug, Clone)]
1352pub struct Variant {
1353 pub name: Ident,
1354 pub payload: Vec<VariantField>,
1355 pub span: Span,
1356}
1357
1358/// One payload field of a sum variant. Variant payload fields use named
1359/// declarations like record fields, but do not carry refinement in v0.2.
1360#[derive(Debug, Clone)]
1361pub struct VariantField {
1362 pub name: Ident,
1363 pub type_ref: TypeRef,
1364 pub span: Span,
1365}
1366
1367#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1368pub enum BaseType {
1369 Int,
1370 String,
1371 Bool,
1372 Float,
1373 /// `Duration` (v0.86, ADR 0112) — a span of time, a distinct base type
1374 /// erased to TS `number` carrying milliseconds (the `Clock` unit). Modelled
1375 /// on `Float`: Bynk-side-only, no implicit `Int` coercion (save the one
1376 /// sanctioned clock-math mix).
1377 Duration,
1378 /// `Instant` (v0.90, ADR 0114) — an absolute point in time, a distinct base
1379 /// type erased to TS `number` carrying Unix epoch milliseconds (the
1380 /// `Clock` unit). No literal (minted by `Clock.now()`); arithmetic composes
1381 /// with `Duration` (`Instant ± Duration -> Instant`, `Instant − Instant ->
1382 /// Duration`). Supersedes ADR 0112 D4's `Int`↔`Duration` clock-math mix.
1383 Instant,
1384 /// `Bytes` (v0.110, ADR 0142) — an immutable finite octet sequence, the
1385 /// seventh base type. Unlike its neighbours it does **not** erase to TS
1386 /// `number`: a `Bytes` lowers to a `Uint8Array`. No source literal
1387 /// (constructed via `Bytes.fromUtf8`/`fromBase64`/`empty`); `==` compares
1388 /// by content (real emitter codegen, not host `===`); wires as a base64
1389 /// JSON string; not `Map`-keyable and not orderable.
1390 Bytes,
1391}
1392
1393impl BaseType {
1394 pub fn name(self) -> &'static str {
1395 match self {
1396 BaseType::Int => "Int",
1397 BaseType::String => "String",
1398 BaseType::Bool => "Bool",
1399 BaseType::Float => "Float",
1400 BaseType::Duration => "Duration",
1401 BaseType::Instant => "Instant",
1402 BaseType::Bytes => "Bytes",
1403 }
1404 }
1405}
1406
1407/// A `Duration` literal unit (v0.86, ADR 0112) — the closed set of suffixes in a
1408/// `<int>.<unit>` literal. Each maps to a fixed millisecond factor (`Duration`
1409/// erases to `Int` milliseconds).
1410#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1411pub enum DurationUnit {
1412 Milliseconds,
1413 Seconds,
1414 Minutes,
1415 Hours,
1416 Days,
1417}
1418
1419impl DurationUnit {
1420 /// Resolve a unit name (`minutes`) to its variant, or `None` if it is not one
1421 /// of the closed set. Used by the parser to recognise an `<int>.<unit>`
1422 /// literal; an unrecognised name leaves the expression a field access.
1423 pub fn from_name(name: &str) -> Option<Self> {
1424 Some(match name {
1425 "milliseconds" => DurationUnit::Milliseconds,
1426 "seconds" => DurationUnit::Seconds,
1427 "minutes" => DurationUnit::Minutes,
1428 "hours" => DurationUnit::Hours,
1429 "days" => DurationUnit::Days,
1430 _ => return None,
1431 })
1432 }
1433
1434 /// The unit name as written.
1435 pub fn name(self) -> &'static str {
1436 match self {
1437 DurationUnit::Milliseconds => "milliseconds",
1438 DurationUnit::Seconds => "seconds",
1439 DurationUnit::Minutes => "minutes",
1440 DurationUnit::Hours => "hours",
1441 DurationUnit::Days => "days",
1442 }
1443 }
1444
1445 /// The unit's value in milliseconds.
1446 pub fn millis(self) -> i64 {
1447 match self {
1448 DurationUnit::Milliseconds => 1,
1449 DurationUnit::Seconds => 1_000,
1450 DurationUnit::Minutes => 60_000,
1451 DurationUnit::Hours => 3_600_000,
1452 DurationUnit::Days => 86_400_000,
1453 }
1454 }
1455}
1456
1457/// An integer refinement bound (v0.40, ADR 0073): the parsed value plus the
1458/// bound's source span (covering a leading `-`). Value-only beyond the span —
1459/// ints have one canonical printed form, so the formatter stays idempotent
1460/// without a stored lexeme. The span backs the `InRange`-swap quick-fix.
1461#[derive(Debug, Clone)]
1462pub struct IntBound {
1463 pub value: i64,
1464 pub span: Span,
1465}
1466
1467/// A float refinement bound (v0.21): the parsed value plus the signed source
1468/// lexeme (for byte-stable emission). v0.40 (ADR 0073): also the source span,
1469/// for the `InRange`-swap quick-fix.
1470#[derive(Debug, Clone)]
1471pub struct FloatBound {
1472 pub value: f64,
1473 pub lexeme: String,
1474 pub span: Span,
1475}
1476
1477#[derive(Debug, Clone)]
1478pub struct Refinement {
1479 pub predicates: Vec<RefinementPred>,
1480 pub span: Span,
1481}
1482
1483#[derive(Debug, Clone)]
1484pub struct RefinementPred {
1485 pub kind: PredKind,
1486 pub span: Span,
1487}
1488
1489#[derive(Debug, Clone)]
1490pub enum PredKind {
1491 Matches(String),
1492 InRange(IntBound, IntBound),
1493 /// `InRange` with float bounds (v0.21) — a separate variant so every
1494 /// `Int` refinement path stays untouched. Bounds keep their source
1495 /// lexemes (including any sign) so emitted runtime checks are
1496 /// byte-stable.
1497 InRangeF(FloatBound, FloatBound),
1498 MinLength(i64),
1499 MaxLength(i64),
1500 Length(i64),
1501 NonNegative,
1502 Positive,
1503 NonEmpty,
1504}
1505
1506impl PredKind {
1507 pub fn name(&self) -> &'static str {
1508 match self {
1509 PredKind::Matches(_) => "Matches",
1510 PredKind::InRange(..) | PredKind::InRangeF(..) => "InRange",
1511 PredKind::MinLength(_) => "MinLength",
1512 PredKind::MaxLength(_) => "MaxLength",
1513 PredKind::Length(_) => "Length",
1514 PredKind::NonNegative => "NonNegative",
1515 PredKind::Positive => "Positive",
1516 PredKind::NonEmpty => "NonEmpty",
1517 }
1518 }
1519}
1520
1521/// A function type parameter (v0.20a, `fn name[A, B](…)`). A struct rather
1522/// than a bare Ident so the ADR-0028 "bound-capable" promise is a later field
1523/// addition, not a representation change.
1524#[derive(Debug, Clone)]
1525pub struct TypeParam {
1526 pub name: Ident,
1527 pub span: Span,
1528}
1529
1530/// A lambda expression (v0.20a): `(params) => expr` or `(params) => { … }`.
1531/// `=>` is the value arrow (shared with `match`); param annotations are
1532/// optional where an expected function type supplies them.
1533#[derive(Debug, Clone)]
1534pub struct LambdaExpr {
1535 pub params: Vec<LambdaParam>,
1536 pub body: Box<Expr>,
1537 pub span: Span,
1538}
1539
1540/// A lambda parameter. A separate type from [`Param`] because its annotation
1541/// is optional — `Param.type_ref` stays mandatory at every signature site.
1542#[derive(Debug, Clone)]
1543pub struct LambdaParam {
1544 pub name: Ident,
1545 pub type_ref: Option<TypeRef>,
1546 pub span: Span,
1547}
1548
1549#[derive(Debug, Clone)]
1550pub struct FnDecl {
1551 /// v0.20a: `[A, B]` type parameters; empty for non-generic functions.
1552 pub type_params: Vec<TypeParam>,
1553 /// Free function or method (`TypeName.methodName`). See [`FnName`].
1554 pub name: FnName,
1555 pub params: Vec<Param>,
1556 pub return_type: TypeRef,
1557 /// v0.115: preconditions (`requires <name>: <pred>`), parsed between the
1558 /// return type and the body. A contract clause is the invariant predicate
1559 /// attached to a function (ADR 0144 — one predicate surface); `requires`
1560 /// scopes over the parameters only.
1561 pub requires: Vec<Contract>,
1562 /// v0.115: postconditions (`ensures <name>: <pred>`). Scopes over the
1563 /// parameters *and* `result`, the contextual binding for the return value.
1564 pub ensures: Vec<Contract>,
1565 pub body: Block,
1566 /// True when the first parameter is the special `self` parameter. Only
1567 /// valid for method declarations.
1568 pub has_self: bool,
1569 /// Documentation block attached to this declaration (v0.3).
1570 pub documentation: Option<String>,
1571 pub span: Span,
1572 pub trivia: Trivia,
1573}
1574
1575/// A function-declaration name: either a free function `f` or a method
1576/// `T.method` (v0.2 §3.6).
1577#[derive(Debug, Clone)]
1578pub enum FnName {
1579 /// `fn name(...)` — a free function.
1580 Free(Ident),
1581 /// `fn TypeName.methodName(...)` — a method attached to a type.
1582 Method {
1583 type_name: Ident,
1584 method_name: Ident,
1585 },
1586}
1587
1588impl FnName {
1589 /// The function's short name for diagnostics. For methods returns the
1590 /// method portion only; the type prefix is recovered via `type_name`.
1591 pub fn ident(&self) -> &Ident {
1592 match self {
1593 FnName::Free(id) => id,
1594 FnName::Method { method_name, .. } => method_name,
1595 }
1596 }
1597
1598 /// For methods, the attached type's identifier; `None` for free fns.
1599 pub fn type_name(&self) -> Option<&Ident> {
1600 match self {
1601 FnName::Free(_) => None,
1602 FnName::Method { type_name, .. } => Some(type_name),
1603 }
1604 }
1605
1606 /// The displayed full name (e.g., `Money.add` or `parseSku`).
1607 pub fn display(&self) -> String {
1608 match self {
1609 FnName::Free(id) => id.name.clone(),
1610 FnName::Method {
1611 type_name,
1612 method_name,
1613 } => format!("{}.{}", type_name.name, method_name.name),
1614 }
1615 }
1616}
1617
1618/// A brace-delimited block of statements ending in a tail expression
1619/// whose value is the block's value (spec v0.1 §3.1).
1620#[derive(Debug, Clone)]
1621pub struct Block {
1622 pub statements: Vec<Statement>,
1623 pub tail: Box<Expr>,
1624 pub span: Span,
1625 /// Line comments that appear between the last statement (or the
1626 /// opening brace) and the tail expression. Preserved here because
1627 /// expressions do not carry trivia in v1.1.
1628 pub tail_leading_comments: Vec<String>,
1629}
1630
1631/// Block-level statement.
1632#[derive(Debug, Clone)]
1633pub enum Statement {
1634 /// `let name (: T)? = expr` — pure binding (v0.1).
1635 Let(LetStmt),
1636 /// `let name (: T)? <- expr` — effectful binding (v0.5).
1637 EffectLet(LetStmt),
1638 /// `expect expr` — verify a Bool predicate at test runtime (v0.7; renamed
1639 /// from `assert` in v0.112). Only valid inside test case bodies.
1640 Expect(ExpectStmt),
1641 /// `~> expr` — an asynchronous fire-and-forget send (v0.79). The caller does
1642 /// not await the reply; legal only when the reply is `Effect[()]`. No binder.
1643 Send(SendStmt),
1644 /// `name := expr` — a `Cell` store write (v0.81, storage track). The
1645 /// unconditional write form; `.update(fn)` (a method call) is the
1646 /// read-modify-write form. ADR 0108.
1647 Assign(AssignStmt),
1648}
1649
1650impl Statement {
1651 pub fn span(&self) -> Span {
1652 match self {
1653 Statement::Let(l) | Statement::EffectLet(l) => l.span,
1654 Statement::Expect(a) => a.span,
1655 Statement::Send(s) => s.span,
1656 Statement::Assign(a) => a.span,
1657 }
1658 }
1659}
1660
1661#[derive(Debug, Clone)]
1662pub struct ExpectStmt {
1663 pub value: Expr,
1664 pub span: Span,
1665 pub trivia: Trivia,
1666}
1667
1668/// `name := expr` — a `Cell` store write (v0.81, storage track). `target` is the
1669/// `Cell` field being written (a bare name for now; the checker resolves it to a
1670/// `store` field). `value` is the new value.
1671#[derive(Debug, Clone)]
1672pub struct AssignStmt {
1673 pub target: Ident,
1674 pub value: Expr,
1675 pub span: Span,
1676 pub trivia: Trivia,
1677}
1678
1679#[derive(Debug, Clone)]
1680pub struct LetStmt {
1681 pub name: Ident,
1682 pub type_annot: Option<TypeRef>,
1683 pub value: Expr,
1684 pub span: Span,
1685 pub trivia: Trivia,
1686}
1687
1688#[derive(Debug, Clone)]
1689pub struct SendStmt {
1690 /// The send target — a recipient call, e.g. `Logger.info(msg)`.
1691 pub value: Expr,
1692 pub span: Span,
1693 pub trivia: Trivia,
1694}
1695
1696#[derive(Debug, Clone)]
1697pub struct Param {
1698 pub name: Ident,
1699 pub type_ref: TypeRef,
1700 pub span: Span,
1701}
1702
1703#[derive(Debug, Clone)]
1704pub enum TypeRef {
1705 Base(BaseType, Span),
1706 Named(Ident),
1707 /// `Result[T, E]` — the built-in generic Result type (v0.1).
1708 Result(Box<TypeRef>, Box<TypeRef>, Span),
1709 /// `Option[T]` — the built-in generic Option type (v0.2).
1710 Option(Box<TypeRef>, Span),
1711 /// `Effect[T]` — the built-in generic Effect type (v0.5).
1712 Effect(Box<TypeRef>, Span),
1713 /// `HttpResult[T]` — the built-in HTTP-result sum (v0.9).
1714 HttpResult(Box<TypeRef>, Span),
1715 /// `QueueResult` — the built-in queue verdict sum (`Ack | Retry`),
1716 /// non-generic; the required return of a queue handler (v0.44).
1717 QueueResult(Span),
1718 /// `List[T]` — the built-in generic immutable list type (v0.20b).
1719 List(Box<TypeRef>, Span),
1720 /// `Map[K, V]` — the built-in generic immutable map type (v0.20b).
1721 /// Keys are confined to value-keyable types
1722 /// (`bynk.types.unkeyable_map_key`).
1723 Map(Box<TypeRef>, Box<TypeRef>, Span),
1724 /// `Query[T]` — the built-in lazy storage-read description (v0.91, ADR 0115).
1725 /// Nameable in a pure helper's return type; non-storable and non-boundary
1726 /// (like `Effect`/`Fn`).
1727 Query(Box<TypeRef>, Span),
1728 /// `Stream[T]` — the value-over-time primitive (v0.100, real-time track
1729 /// slice 0). A lazy, pull-shaped sequence produced over time; non-storable
1730 /// and non-boundary (like `Query`/`Effect`/`Fn`).
1731 Stream(Box<TypeRef>, Span),
1732 /// `Connection[F]` — a held WebSocket connection (v0.102, real-time track
1733 /// slice 2). `F` is the server→client frame type. A `Held` resource:
1734 /// non-serialisable, non-boundary, and governed by the linearity discipline
1735 /// (§2.9); storable only in `Cell[Option[Connection]]` / `Map[K, Connection]`.
1736 Connection(Box<TypeRef>, Span),
1737 /// `History[Agent]` — a generated, driven call-history of an agent (v0.119,
1738 /// testing track slice 7, ADR 0155). A test-only generator, legal only in
1739 /// `for all` binding position inside a `property`; it is not a value type,
1740 /// so it never resolves in a field/param/return position. The bound subject
1741 /// behaves as an ordinary `List[Step]`.
1742 History(Box<TypeRef>, Span),
1743 /// `ValidationError` — the built-in error type used by refined-type
1744 /// constructors (v0.1).
1745 ValidationError(Span),
1746 /// `JsonError` — the built-in JSON-decode error type (v0.22b). A
1747 /// uniform record (`kind`/`path`/`message`, all `String`) the codec
1748 /// maps `BoundaryError` variants and parse failures into.
1749 JsonError(Span),
1750 /// `()` — the unit type (v0.5).
1751 Unit(Span),
1752 /// `A -> B` / `(A, B) -> C` / `() -> B` — a function type (v0.20a).
1753 /// Right-associative; effectful iff the return type is `Effect[_]`
1754 /// (the structural rule). Confined to non-boundary positions
1755 /// (`bynk.types.function_at_boundary`).
1756 Fn(Vec<TypeRef>, Box<TypeRef>, Span),
1757}
1758
1759impl TypeRef {
1760 pub fn span(&self) -> Span {
1761 match self {
1762 TypeRef::Base(_, s) => *s,
1763 TypeRef::Named(id) => id.span,
1764 TypeRef::Result(_, _, s) => *s,
1765 TypeRef::Option(_, s) => *s,
1766 TypeRef::Effect(_, s) => *s,
1767 TypeRef::HttpResult(_, s) => *s,
1768 TypeRef::QueueResult(s) => *s,
1769 TypeRef::List(_, s) => *s,
1770 TypeRef::Map(_, _, s) => *s,
1771 TypeRef::Query(_, s) => *s,
1772 TypeRef::Stream(_, s) => *s,
1773 TypeRef::Connection(_, s) => *s,
1774 TypeRef::History(_, s) => *s,
1775 TypeRef::ValidationError(s) => *s,
1776 TypeRef::JsonError(s) => *s,
1777 TypeRef::Unit(s) => *s,
1778 TypeRef::Fn(_, _, s) => *s,
1779 }
1780 }
1781}
1782
1783#[derive(Debug, Clone)]
1784pub struct Expr {
1785 pub kind: ExprKind,
1786 pub span: Span,
1787}
1788
1789#[derive(Debug, Clone)]
1790pub enum ExprKind {
1791 IntLit(i64),
1792 /// A float literal (v0.21). The lexeme is kept alongside the parsed
1793 /// value so emission and formatting are byte-stable (`1e10` must not
1794 /// normalise to `10000000000`).
1795 FloatLit {
1796 value: f64,
1797 lexeme: String,
1798 },
1799 /// A duration literal `<int>.<unit>` (v0.86, ADR 0112): `5.minutes`,
1800 /// `30.days`. The parser recognises the `IntLit . <unit>` shape and records
1801 /// the magnitude, the unit, and the resolved milliseconds (the value the
1802 /// emitter lowers to). Typed `Duration`.
1803 DurationLit {
1804 /// The integer magnitude as written (`5` in `5.minutes`).
1805 value: i64,
1806 /// The unit name (`minutes`), one of the closed set.
1807 unit: DurationUnit,
1808 /// The value in milliseconds — `value * unit factor`.
1809 millis: i64,
1810 },
1811 StrLit(String),
1812 /// An interpolated string `"… \(expr) …"` (v0.43, ADR 0075). Chunks and
1813 /// holes alternate. A plain `"…"` with no holes stays [`ExprKind::StrLit`],
1814 /// so existing code and the emitter/formatter fast-path are untouched.
1815 InterpStr(Vec<InterpPart>),
1816 BoolLit(bool),
1817 Ident(Ident),
1818 Call {
1819 name: Ident,
1820 /// v0.20a: explicit type arguments (`name[T](…)`); empty when absent.
1821 type_args: Vec<TypeRef>,
1822 args: Vec<Expr>,
1823 },
1824 /// A lambda (v0.20a). See [`LambdaExpr`].
1825 Lambda(LambdaExpr),
1826 BinOp(BinOp, Box<Expr>, Box<Expr>),
1827 UnaryOp(UnaryOp, Box<Expr>),
1828 Paren(Box<Expr>),
1829 /// `{ stmts; expr }` — block expression (v0.1).
1830 Block(Block),
1831 /// `if cond { then } else { else }` (v0.1).
1832 If {
1833 cond: Box<Expr>,
1834 then_block: Box<Block>,
1835 else_block: Box<Block>,
1836 },
1837 /// `Ok(value)` — Result success constructor (v0.1).
1838 Ok(Box<Expr>),
1839 /// `Err(error)` — Result failure constructor (v0.1).
1840 Err(Box<Expr>),
1841 /// `expr?` — propagation operator (v0.1).
1842 Question(Box<Expr>),
1843 /// `TypeName.method(args)` — qualified static call on a type
1844 /// (v0.1: only refined-type `of`; v0.2: any static method or variant
1845 /// constructor for sum types). The resolver decides which.
1846 ConstructorCall {
1847 type_name: Ident,
1848 method: Ident,
1849 args: Vec<Expr>,
1850 },
1851 /// `TypeName { field: value, ... }` — record construction (v0.2).
1852 RecordConstruction {
1853 type_name: Ident,
1854 fields: Vec<FieldInit>,
1855 },
1856 /// `receiver.field` — field access on a record value (v0.2). v0.3 adds
1857 /// `.raw` on opaque types within the defining commons.
1858 FieldAccess {
1859 receiver: Box<Expr>,
1860 field: Ident,
1861 },
1862 /// `receiver.method(args)` — instance method call (v0.2). The
1863 /// resolver determines the receiver's type and looks up the method.
1864 MethodCall {
1865 receiver: Box<Expr>,
1866 method: Ident,
1867 /// v0.22b: explicit type arguments on a qualified static
1868 /// (`Json.decode[T](…)`); empty when absent. The same-line-`[`
1869 /// rule applies as for `Call` type application (0039).
1870 type_args: Vec<TypeRef>,
1871 args: Vec<Expr>,
1872 },
1873 /// `match disc { arm+ }` — pattern matching (v0.2).
1874 Match {
1875 discriminant: Box<Expr>,
1876 arms: Vec<MatchArm>,
1877 },
1878 /// `expr is pattern` — pattern test, returns Bool (v0.2).
1879 Is {
1880 value: Box<Expr>,
1881 pattern: Pattern,
1882 },
1883 /// `Some(value)` — Option Some constructor (v0.2).
1884 Some(Box<Expr>),
1885 /// `None` — Option None constructor (v0.2).
1886 None,
1887 /// `()` — unit literal (v0.5).
1888 UnitLit,
1889 /// `TypeName { ...base, field: value, ... }` or `{ ...base, ... }` —
1890 /// record spread expression (v0.5).
1891 RecordSpread {
1892 /// Optional type prefix (`TypeName { ...base }`). Absent for the
1893 /// bare form used inside `commit`.
1894 type_name: Option<Ident>,
1895 /// The base record being spread.
1896 base: Box<Expr>,
1897 /// Field overrides (always full `name: value` form — never shorthand).
1898 overrides: Vec<FieldInit>,
1899 },
1900 /// `Effect.pure(value)` — wrap a synchronous value into `Effect[T]`
1901 /// (v0.5). Recognised in the parser as a special-form.
1902 EffectPure(Box<Expr>),
1903 /// `expect expr` — expectation as an expression of type `()` (v0.9.1;
1904 /// renamed from `assert` in v0.112). Valid only inside test bodies. Evaluates
1905 /// `expr` (must be Bool); if false, the surrounding test case fails.
1906 Expect(Box<Expr>),
1907 /// `Val[T]`, `Val[T](args)` — test-context value construction (v0.9.4).
1908 /// `args` is empty for the bare form and holds the pin arguments for
1909 /// `Val[T](...)`. The record-override form `Val[T] { ... }` is not yet
1910 /// parsed. Valid only inside test bodies; has type `T`.
1911 Val {
1912 type_ref: TypeRef,
1913 args: Vec<Expr>,
1914 },
1915 /// `[a, b, c]` — list literal (v0.20b). An empty `[]` requires an
1916 /// expected type (`bynk.types.uninferable_element_type`).
1917 ListLit(Vec<Expr>),
1918 /// An observation over a consumed capability's recorded calls (v0.117,
1919 /// testing track slice 5). The direct subject of an `expect` in a `case`
1920 /// body — `expect Cap.op called once with <pred>`, `expect Cap.op never
1921 /// called`, `expect A.op before B.op`. Types as `Bool` (the claim about the
1922 /// recorded trace), lowered to a boolean over the recorded log.
1923 Observation(ObservationExpr),
1924 /// `trace(Cap.op)` — the bound-trace escape hatch (v0.117, testing track
1925 /// slice 5). Yields the recorded calls of `Cap.op` as a `List[<CallRecord>]`
1926 /// (a synthetic record of the operation's parameters), asserted over with the
1927 /// ordinary value surface. Test-body-only, like [`ExprKind::Val`].
1928 Trace {
1929 cap: Ident,
1930 op: Ident,
1931 },
1932}
1933
1934/// An observation of a capability operation's recorded calls (v0.117, testing
1935/// track slice 5). `cap`/`op` name the seam (`Logger.log`); `matcher` is the
1936/// claim about the recorded calls.
1937#[derive(Debug, Clone)]
1938pub struct ObservationExpr {
1939 pub cap: Ident,
1940 pub op: Ident,
1941 pub matcher: ObservationMatcher,
1942}
1943
1944/// The claim an [`ObservationExpr`] makes about a seam's recorded calls (v0.117).
1945#[derive(Debug, Clone)]
1946pub enum ObservationMatcher {
1947 /// `called` [`once` | `<n> times`]? [`with` `<pred>`]?. `count` is `None`
1948 /// for a bare `called` (at least one); `Some(expr)` is the exact-count claim
1949 /// (a literal; `once` desugars to `1`). `with_pred` matches a call whose
1950 /// arguments (in scope by the operation's parameter names) satisfy it.
1951 Called {
1952 count: Option<Box<Expr>>,
1953 with_pred: Option<Box<Expr>>,
1954 },
1955 /// `never called` — zero calls.
1956 NeverCalled,
1957 /// `before Cap.op` — the first call of the subject precedes the first call
1958 /// of the named operation (both must have occurred).
1959 Before { cap: Ident, op: Ident },
1960}
1961
1962/// One part of an interpolated string (v0.43, ADR 0075). An
1963/// [`ExprKind::InterpStr`] holds an alternating run of these.
1964#[derive(Debug, Clone)]
1965pub enum InterpPart {
1966 /// Literal text between holes, with escapes already resolved.
1967 Chunk(String),
1968 /// An interpolated expression `\(expr)`. Type-checked by the hole rule
1969 /// (base scalars only; see the checker) and lowered into a template-
1970 /// literal `${…}` slot.
1971 Hole(Box<Expr>),
1972}
1973
1974/// One field-initialiser inside a record construction expression:
1975/// either `name: expr` or the shorthand `name` (which requires a binding
1976/// of the same name in scope and uses its value).
1977#[derive(Debug, Clone)]
1978pub struct FieldInit {
1979 pub name: Ident,
1980 /// `None` means shorthand — the field's value is the same-named binding.
1981 pub value: Option<Expr>,
1982 pub span: Span,
1983}
1984
1985/// One arm of a `match` expression: `pattern => body`.
1986#[derive(Debug, Clone)]
1987pub struct MatchArm {
1988 pub pattern: Pattern,
1989 pub body: MatchBody,
1990 pub span: Span,
1991}
1992
1993/// The right-hand side of a match arm — either a single expression or
1994/// a block.
1995#[derive(Debug, Clone)]
1996pub enum MatchBody {
1997 Expr(Expr),
1998 Block(Block),
1999}
2000
2001impl MatchBody {
2002 pub fn span(&self) -> Span {
2003 match self {
2004 MatchBody::Expr(e) => e.span,
2005 MatchBody::Block(b) => b.span,
2006 }
2007 }
2008}
2009
2010/// A pattern (v0.2 §3.8). Patterns appear in `match` arms and as the
2011/// right-hand side of the `is` operator.
2012#[derive(Debug, Clone)]
2013pub enum Pattern {
2014 /// `_` — matches any value, no bindings.
2015 Wildcard(Span),
2016 /// A literal pattern — `31`, `"english"`, `true` (v0.130 §2.3.4). Matches a
2017 /// primitive scrutinee (`Int`/`String`/`Bool`) by value equality. The
2018 /// admitted set mirrors ADR 0001's closed literal set (integers — including
2019 /// a leading unary minus — strings, and booleans); `Float`/`()` are not
2020 /// admitted as patterns.
2021 Literal { value: LiteralValue, span: Span },
2022 /// `Variant` or `Variant(bindings)` or `TypeName.Variant(bindings)`.
2023 Variant {
2024 /// Optional qualifier: `TypeName.Variant`.
2025 type_name: Option<Ident>,
2026 /// The variant name.
2027 variant: Ident,
2028 /// Payload bindings (empty for nullary variants).
2029 bindings: Vec<PatternBinding>,
2030 span: Span,
2031 },
2032}
2033
2034/// The value carried by a [`Pattern::Literal`]. A closed set (ADR 0001):
2035/// integer, string, and boolean. Kept distinct from [`ExprKind`] so patterns
2036/// carry only what they can actually match, and so it is `Eq`/`Hash` for the
2037/// duplicate-arm check.
2038#[derive(Debug, Clone, PartialEq, Eq, Hash)]
2039pub enum LiteralValue {
2040 Int(i64),
2041 Str(String),
2042 Bool(bool),
2043}
2044
2045impl LiteralValue {
2046 /// A human-readable rendering for diagnostics (`31`, `"english"`, `true`).
2047 pub fn describe(&self) -> String {
2048 match self {
2049 LiteralValue::Int(n) => n.to_string(),
2050 LiteralValue::Str(s) => format!("{s:?}"),
2051 LiteralValue::Bool(b) => b.to_string(),
2052 }
2053 }
2054}
2055
2056impl Pattern {
2057 pub fn span(&self) -> Span {
2058 match self {
2059 Pattern::Wildcard(s) => *s,
2060 Pattern::Literal { span, .. } => *span,
2061 Pattern::Variant { span, .. } => *span,
2062 }
2063 }
2064}
2065
2066/// A single binding inside a variant pattern. Two surface forms:
2067/// `name` (positional — bind the i-th payload field) and
2068/// `fieldName: bindName` (named — bind the named payload field).
2069/// Both forms also accept `_` as the bind name to discard.
2070#[derive(Debug, Clone)]
2071pub struct PatternBinding {
2072 /// Source form: positional or named.
2073 pub kind: PatternBindingKind,
2074 pub span: Span,
2075}
2076
2077#[derive(Debug, Clone)]
2078pub enum PatternBindingKind {
2079 /// `name` (or `_`): bind the payload field at this position to `name`.
2080 Positional { name: Ident },
2081 /// `field: name` (or `field: _`): bind the named payload field to `name`.
2082 Named { field: Ident, name: Ident },
2083}
2084
2085impl PatternBinding {
2086 /// The local name introduced by this binding (used for scope).
2087 /// `_` is a sentinel for "no binding"; callers should compare against it.
2088 pub fn local_name(&self) -> &Ident {
2089 match &self.kind {
2090 PatternBindingKind::Positional { name } => name,
2091 PatternBindingKind::Named { name, .. } => name,
2092 }
2093 }
2094
2095 pub fn is_wildcard(&self) -> bool {
2096 self.local_name().name == "_"
2097 }
2098}
2099
2100#[derive(Debug, Clone, Copy, PartialEq, Eq)]
2101pub enum BinOp {
2102 /// `P implies Q` — logical implication (v0.80). Desugars to `!P || Q`; sits
2103 /// at the lowest precedence (below `||`). Reads directionally (P → Q).
2104 Implies,
2105 Or,
2106 And,
2107 Eq,
2108 NotEq,
2109 Lt,
2110 LtEq,
2111 Gt,
2112 GtEq,
2113 Add,
2114 Sub,
2115 Mul,
2116 Div,
2117}
2118
2119impl BinOp {
2120 pub fn name(self) -> &'static str {
2121 match self {
2122 BinOp::Implies => "implies",
2123 BinOp::Or => "||",
2124 BinOp::And => "&&",
2125 BinOp::Eq => "==",
2126 BinOp::NotEq => "!=",
2127 BinOp::Lt => "<",
2128 BinOp::LtEq => "<=",
2129 BinOp::Gt => ">",
2130 BinOp::GtEq => ">=",
2131 BinOp::Add => "+",
2132 BinOp::Sub => "-",
2133 BinOp::Mul => "*",
2134 BinOp::Div => "/",
2135 }
2136 }
2137}
2138
2139#[derive(Debug, Clone, Copy, PartialEq, Eq)]
2140pub enum UnaryOp {
2141 Neg,
2142 Not,
2143}
2144
2145impl UnaryOp {
2146 pub fn name(self) -> &'static str {
2147 match self {
2148 UnaryOp::Neg => "-",
2149 UnaryOp::Not => "!",
2150 }
2151 }
2152}