Strings and destructuring

Author: Rigidity

docs/bindings.md

@@ -42,3 +42,40 @@ This should be used sparingly, since it can come with either a performance hit,
 :::tip
 The compiler will automatically inline `let` bindings if they are only referenced a single time.
 :::
+
+## Destructuring
+
+You can destructure values (including `let` bindings and function parameters) into multiple bindings at once.
+
+For example, if you have a pair, you can destructure the first and rest values into separate bindings:
+
+```rue
+let (first, rest) = (100, 200);
+```
+
+This also works for lists (as long as the values are known to not be nil):
+
+```rue
+let [a, b, c] = [100, 200, 300];
+```
+
+If you have a struct, you can destructure the fields:
+
+```rue
+struct Point {
+    x: Int,
+    y: Int,
+}
+
+let { x, y } = Point { x: 100, y: 200 };
+```
+
+These destructuring patterns can be combined arbitrarily:
+
+```rue
+let ([a, b, c], { x, y }) = ([100, 200, 300], Point { x: 400, y: 500 });
+```
+
+:::note
+When you destructure a value, it's first assigned to a temporary binding, and then that binding is referenced by each of the bindings in the destructuring pattern. Thus, if you're destructuring a non-inline variable, it's best to mark the destructured bindings as `inline` to reduce the size of the compiled program.
+:::

docs/builtins.md

@@ -13,17 +13,18 @@ You can click on each of these types to go to their corresponding page and learn
 1. [**Atom**](/docs/type-system/atoms.md#atom)
 2. [**Bytes**](/docs/type-system/atoms.md#bytes)
 3. [**Bytes32**](/docs/type-system/atoms.md#bytes32)
-4. [**PublicKey**](/docs/type-system/atoms.md#publickey)
-5. [**Signature**](/docs/type-system/atoms.md#signature)
-6. [**K1PublicKey**](/docs/type-system/atoms.md#k1publickey)
-7. [**K1Signature**](/docs/type-system/atoms.md#k1signature)
-8. [**R1PublicKey**](/docs/type-system/atoms.md#r1publickey)
-9. [**R1Signature**](/docs/type-system/atoms.md#r1signature)
-10. [**Int**](/docs/type-system/atoms.md#int)
-11. [**Bool**](/docs/type-system/atoms.md#bool)
-12. [**Any**](/docs/type-system/pairs.md#any)
-13. [**List**](/docs/type-system/pairs.md#lists)
-14. [**AlternatingList**](/docs/type-system/pairs.md#alternating-lists)
+4. [**String**](/docs/type-system/atoms.md#string)
+5. [**PublicKey**](/docs/type-system/atoms.md#publickey)
+6. [**Signature**](/docs/type-system/atoms.md#signature)
+7. [**K1PublicKey**](/docs/type-system/atoms.md#k1publickey)
+8. [**K1Signature**](/docs/type-system/atoms.md#k1signature)
+9. [**R1PublicKey**](/docs/type-system/atoms.md#r1publickey)
+10. [**R1Signature**](/docs/type-system/atoms.md#r1signature)
+11. [**Int**](/docs/type-system/atoms.md#int)
+12. [**Bool**](/docs/type-system/atoms.md#bool)
+13. [**Any**](/docs/type-system/pairs.md#any)
+14. [**List**](/docs/type-system/pairs.md#lists)
+15. [**AlternatingList**](/docs/type-system/pairs.md#alternating-lists)
 
 ## Functions
 

docs/constants.md

@@ -11,9 +11,9 @@ They are similar to [Bindings](/docs/bindings.md), which the primary difference
 As a simple example, you might want to reuse a string multiple times:
 
 ```rue
-const GREET: Bytes = "Hello, ";
+const GREET: String = "Hello, ";
 
-fn main(person_a: Bytes, person_b: Bytes) -> (Bytes, Bytes) {
+fn main(person_a: String, person_b: String) -> (String, String) {
     (GREET + person_a, GREET + person_b)
 }
 ```
@@ -25,9 +25,9 @@ You can mark a constant as `inline`, which forces its value to be inserted every
 As an example, this will behave the same as if you had written the string multiple times:
 
 ```rue
-inline const GREET: Bytes = "Hello, ";
+inline const GREET: String = "Hello, ";
 
-fn main(person_a: Bytes, person_b: Bytes) -> (Bytes, Bytes) {
+fn main(person_a: String, person_b: String) -> (String, String) {
     (GREET + person_a, GREET + person_b)
 }
 ```

docs/installation.md

@@ -71,7 +71,7 @@ The simplest example of a program in Rue is the classic hello world example.
 Write the following program in a file named `hello.rue`:
 
 ```rue title="hello.rue"
-fn main() -> Bytes {
+fn main() -> String {
     "Hello, world!"
 }
 ```

docs/type-system/atoms.md

@@ -11,14 +11,15 @@ There are multiple types of atoms:
 1. **Atom** - has no semantic meaning
 2. **Bytes** - explicitly treated as bytes
 3. **Bytes32** - a `Bytes` value with a length of 32
-4. **PublicKey** - a [BLS12-381](https://en.wikipedia.org/wiki/BLS_digital_signature) public key with a length of 48 bytes
-5. **Signature** - a [BLS12-381](https://en.wikipedia.org/wiki/BLS_digital_signature) signature with a length of 96 bytes
-6. **K1PublicKey** - a secp256k1 public key with a length of 33 bytes
-7. **K1Signature** - a secp256k1 signature with a length of 64 bytes
-8. **R1PublicKey** - a secp256r1 public key with a length of 33 bytes
-9. **R1Signature** - a secp256r1 signature with a length of 64 bytes
-10. **Int** - a signed integer of arbitrary size
-11. **Bool** - either `true` or `false`
+4. **String** - a UTF-8 encoded string
+5. **PublicKey** - a [BLS12-381](https://en.wikipedia.org/wiki/BLS_digital_signature) public key with a length of 48 bytes
+6. **Signature** - a [BLS12-381](https://en.wikipedia.org/wiki/BLS_digital_signature) signature with a length of 96 bytes
+7. **K1PublicKey** - a secp256k1 public key with a length of 33 bytes
+8. **K1Signature** - a secp256k1 signature with a length of 64 bytes
+9. **R1PublicKey** - a secp256r1 public key with a length of 33 bytes
+10. **R1Signature** - a secp256r1 signature with a length of 64 bytes
+11. **Int** - a signed integer of arbitrary size
+12. **Bool** - either `true` or `false`
 
 ## Atom
 
@@ -56,6 +57,10 @@ This will emit code at runtime to check that the value has a length of 32.
 `Bytes32` can only guarantee the length of trusted values. See the [Security](/docs/security.md#untrusted-values) page for more details.
 :::
 
+## String
+
+The `String` type represents a UTF-8 encoded string. It's functionally equivalent to `Bytes`, but provides a more descriptive name for working with text values, and hints to the compiler that the value is a string rather than a sequence of bytes (which is useful for error messages).
+
 ## PublicKey
 
 The `PublicKey` type represents a [BLS12-381](https://en.wikipedia.org/wiki/BLS_digital_signature) public key (also commonly referred to as a G1 element).

docs/type-system/structs.md

@@ -77,10 +77,10 @@ While the type can technically be inferred, it's often necessary to explicitly u
 Default values are always inlined exactly as written. If the value is expensive to compute, or would require a lot of bytes to duplicate in the output program, it should be extracted out into a constant:
 
 ```rue
-const DEFAULT_NAME: Bytes = "Patricia";
+const DEFAULT_NAME: String = "Patricia";
 
 struct Person {
-    name: Bytes = DEFAULT_NAME,
+    name: String = DEFAULT_NAME,
 }
 ```
 

src/theme/prism-rue.ts

@@ -41,7 +41,7 @@ Prism.languages.rue = {
     alias: "keyword",
   },
   module: {
-    pattern: /\b(?:import|mod)\b/,
+    pattern: /\b(?:import|mod|super)\b/,
     alias: "keyword",
   },
   modifier: { pattern: /\b(?:inline|export|extern|test)\b/, alias: "keyword" },
@@ -51,7 +51,7 @@ Prism.languages.rue = {
     alias: "constant",
   },
   builtin:
-    /\b(?:Atom|Bytes|Bytes32|PublicKey|Signature|K1PublicKey|K1Signature|R1PublicKey|R1Signature|Int|Bool|Any|List|AlternatingList)\b/,
+    /\b(?:Atom|Bytes|String|Bytes32|PublicKey|Signature|K1PublicKey|K1Signature|R1PublicKey|R1Signature|Int|Bool|Any|List|AlternatingList)\b/,
   "class-name": /\b[A-Z][a-z][a-zA-Z0-9_]*\b/,
   constant: /\b[A-Z][A-Z0-9_]*\b/,
 };