summaryrefslogtreecommitdiff
path: root/subprojects/boost-sqlite/doc/reference/cstring_ref.adoc
diff options
context:
space:
mode:
authorJohn Turner <jturner.usa@gmail.com>2025-09-14 00:16:10 -0400
committerJohn Turner <jturner.usa@gmail.com>2025-09-14 00:16:10 -0400
commit13e0821fd783a1d5083d825af53cf20e8dcbfd76 (patch)
tree1ea363b0f13b3e87d177100e6ae6b9f30a2de1b8 /subprojects/boost-sqlite/doc/reference/cstring_ref.adoc
parentaa55cb93036a89c64c08e08f4e1de4fa1fd5a775 (diff)
parentefcea3a80da7c4479d5fe168435ecc9fd06bdc72 (diff)
downloadsqlite-kv-bench-13e0821fd783a1d5083d825af53cf20e8dcbfd76.tar.gz
Merge commit 'efcea3a80da7c4479d5fe168435ecc9fd06bdc72' as 'subprojects/boost-sqlite'
Diffstat (limited to 'subprojects/boost-sqlite/doc/reference/cstring_ref.adoc')
-rw-r--r--subprojects/boost-sqlite/doc/reference/cstring_ref.adoc16
1 files changed, 16 insertions, 0 deletions
diff --git a/subprojects/boost-sqlite/doc/reference/cstring_ref.adoc b/subprojects/boost-sqlite/doc/reference/cstring_ref.adoc
new file mode 100644
index 0000000..402663d
--- /dev/null
+++ b/subprojects/boost-sqlite/doc/reference/cstring_ref.adoc
@@ -0,0 +1,16 @@
+== `sqlite/cstring_ref.hpp`
+
+[#string_view]
+
+The `sqlite::string_view` class is a https://en.cppreference.com/w/cpp/string/basic_string_view[std::string_view]
+compatible class.
+
+[#cstring_ref]
+
+The `cstring_ref` class is a view type similar to a `string_view`, but with a guarantee that it is null-terminated.
+
+It can be constructed from a raw `const char *` or any class that has a `c_str()` function returning a `const char *`.
+
+Otherwise it is similar to a `string_view`, except that `substr(std::size_t())` will return a `cstring_ref`,
+whereas a `substr(std::size_t(), std::size_t())` returns a `string_view`.
+