aboutsummaryrefslogtreecommitdiff
path: root/api/c_strings.md
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2025-10-18 19:02:07 -0400
committerBruce Hill <bruce@bruce-hill.com>2025-10-18 19:02:07 -0400
commit5bdf96234a388cbd3854747b0667620ebb60ccdf (patch)
treee4ab4055e0190f4a080b69fcd933cd8ca6146260 /api/c_strings.md
parent82e3c05d547b2372ca4033c68469479260092b5a (diff)
Improved CLI parsing and add CString.join()
Diffstat (limited to 'api/c_strings.md')
-rw-r--r--api/c_strings.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/api/c_strings.md b/api/c_strings.md
new file mode 100644
index 00000000..35bb44d9
--- /dev/null
+++ b/api/c_strings.md
@@ -0,0 +1,46 @@
+% API
+
+# Builtins
+
+# CString
+## CString.as_text
+
+```tomo
+CString.as_text : func(str: CString -> Text)
+```
+
+Convert a C string to Text.
+
+Argument | Type | Description | Default
+---------|------|-------------|---------
+str | `CString` | The C string. | -
+
+**Return:** The C string as a Text.
+
+
+**Example:**
+```tomo
+assert CString("Hello").as_text() == "Hello"
+
+```
+## CString.join
+
+```tomo
+CString.join : func(glue: CString, pieces: [CString] -> CString)
+```
+
+Join a list of C strings together with a separator.
+
+Argument | Type | Description | Default
+---------|------|-------------|---------
+glue | `CString` | The C joiner used to between elements. | -
+pieces | `[CString]` | A list of C strings to join. | -
+
+**Return:** A C string of the joined together bits.
+
+
+**Example:**
+```tomo
+assert CString(",").join([CString("a"), CString("b")]) == CString("a,b")
+
+```