@stryke/capnp 0.12.96 → 0.12.97

package/schemas/schema.cjs

@@ -1,4 +1,5 @@
-const require_src = require('./src-2eLj6yCr.cjs');
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_src = require('./src-B6FhDNiV.cjs');
 
 //#region schemas/schema.ts
 const _capnpFileId = BigInt("0xa93fc509624c72d9");
@@ -499,10 +500,38 @@ var Node_Annotation = class extends require_src.Struct {
 };
 const Node_Which = {
 	FILE: 0,
+	/**
+	* Name to present to humans to identify this Node.  You should not attempt to parse this.  Its
+	* format could change.  It is not guaranteed to be unique.
+	*
+	* (On Zooko's triangle, this is the node's nickname.)
+	*
+	*/
 	STRUCT: 1,
+	/**
+	* If you want a shorter version of `displayName` (just naming this node, without its surrounding
+	* scope), chop off this many characters from the beginning of `displayName`.
+	*
+	*/
 	ENUM: 2,
+	/**
+	* ID of the lexical parent node.  Typically, the scope node will have a NestedNode pointing back
+	* at this node, but robust code should avoid relying on this (and, in fact, group nodes are not
+	* listed in the outer struct's nestedNodes, since they are listed in the fields).  `scopeId` is
+	* zero if the node has no parent, which is normally only the case with files, but should be
+	* allowed for any kind of node (in order to make runtime type generation easier).
+	*
+	*/
 	INTERFACE: 3,
+	/**
+	* List of nodes nested within this node, along with the names under which they were declared.
+	*
+	*/
 	CONST: 4,
+	/**
+	* Annotations applied to this node.
+	*
+	*/
 	ANNOTATION: 5
 };
 var Node = class Node extends require_src.Struct {
@@ -828,6 +857,13 @@ var Field_Group = class extends require_src.Struct {
 };
 const Field_Ordinal_Which = {
 	IMPLICIT: 0,
+	/**
+	* The original ordinal number given to the field.  You probably should NOT use this; if you need
+	* a numeric identifier for a field, use its position within the field array for its scope.
+	* The ordinal is given here mainly just so that the original schema text can be reproduced given
+	* the compiled version -- i.e. so that `capnp compile -ocapnp` can do its job.
+	*
+	*/
 	EXPLICIT: 1
 };
 var Field_Ordinal = class extends require_src.Struct {
@@ -871,6 +907,15 @@ var Field_Ordinal = class extends require_src.Struct {
 };
 const Field_Which = {
 	SLOT: 0,
+	/**
+	* Indicates where this member appeared in the code, relative to other members.
+	* Code ordering may have semantic relevance -- programmers tend to place related fields
+	* together.  So, using code ordering makes sense in human-readable formats where ordering is
+	* otherwise irrelevant, like JSON.  The values of codeOrder are tightly-packed, so the maximum
+	* value is count(members) - 1.  Fields that are members of a union are only ordered relative to
+	* the other members of that union, so the maximum value there is count(union.members).
+	*
+	*/
 	GROUP: 1
 };
 /**
@@ -1346,9 +1391,25 @@ var Type_Interface = class extends require_src.Struct {
 	}
 };
 const Type_AnyPointer_Unconstrained_Which = {
+	/**
+	* truly AnyPointer
+	*
+	*/
 	ANY_KIND: 0,
+	/**
+	* AnyStruct
+	*
+	*/
 	STRUCT: 1,
+	/**
+	* AnyList
+	*
+	*/
 	LIST: 2,
+	/**
+	* Capability
+	*
+	*/
 	CAPABILITY: 3
 };
 /**
@@ -1457,8 +1518,25 @@ var Type_AnyPointer_ImplicitMethodParameter = class extends require_src.Struct {
 	}
 };
 const Type_AnyPointer_Which = {
+	/**
+	* A regular AnyPointer.
+	*
+	* The name "unconstrained" means as opposed to constraining it to match a type parameter.
+	* In retrospect this name is probably a poor choice given that it may still be constrained
+	* to be a struct, list, or capability.
+	*
+	*/
 	UNCONSTRAINED: 0,
+	/**
+	* This is actually a reference to a type parameter defined within this scope.
+	*
+	*/
 	PARAMETER: 1,
+	/**
+	* This is actually a reference to an implicit (generic) parameter of a method. The only
+	* legal context for this type to appear is inside Method.paramBrand or Method.resultBrand.
+	*
+	*/
 	IMPLICIT_METHOD_PARAMETER: 2
 };
 var Type_AnyPointer = class extends require_src.Struct {
@@ -1748,7 +1826,15 @@ var Type = class extends require_src.Struct {
 	}
 };
 const Brand_Scope_Which = {
+	/**
+	* ID of the scope to which these params apply.
+	*
+	*/
 	BIND: 0,
+	/**
+	* List of parameter bindings.
+	*
+	*/
 	INHERIT: 1
 };
 var Brand_Scope = class Brand_Scope extends require_src.Struct {
@@ -1922,6 +2008,11 @@ const Value_Which = {
 	LIST: 14,
 	ENUM: 15,
 	STRUCT: 16,
+	/**
+	* The only interface value that can be represented statically is "null", whose methods always
+	* throw exceptions.
+	*
+	*/
 	INTERFACE: 17,
 	ANY_POINTER: 18
 };
@@ -2272,6 +2363,10 @@ var Annotation = class extends require_src.Struct {
 	}
 };
 const ElementSize = {
+	/**
+	* aka "void", but that's a keyword.
+	*
+	*/
 	EMPTY: 0,
 	BIT: 1,
 	BYTE: 2,