aboutsummaryrefslogtreecommitdiff
path: root/api/c_strings.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'api/c_strings.yaml')
-rw-r--r--api/c_strings.yaml35
1 files changed, 35 insertions, 0 deletions
diff --git a/api/c_strings.yaml b/api/c_strings.yaml
new file mode 100644
index 00000000..7607bc9e
--- /dev/null
+++ b/api/c_strings.yaml
@@ -0,0 +1,35 @@
+CString.as_text:
+ short: convert a C string to Text
+ description: >
+ Convert a C string to Text.
+ return:
+ type: 'Text'
+ description: >
+ The C string as a Text.
+ args:
+ str:
+ type: 'CString'
+ description: >
+ The C string.
+ example: |
+ assert CString("Hello").as_text() == "Hello"
+
+CString.join:
+ short: join a list of C strings
+ description: >
+ Join a list of C strings together with a separator.
+ return:
+ type: 'CString'
+ description: >
+ A C string of the joined together bits.
+ args:
+ glue:
+ type: 'CString'
+ description: >
+ The C joiner used to between elements.
+ pieces:
+ type: '[CString]'
+ description: >
+ A list of C strings to join.
+ example: |
+ assert CString(",").join([CString("a"), CString("b")]) == CString("a,b")