Though, one has to be careful about the fact that str* functions often
stop on NULs and that strbufs may have embedded NULs.
- An strbuf is NUL terminated for convenience, but no function in the
+ A strbuf is NUL terminated for convenience, but no function in the
strbuf API actually relies on the string being free of NULs.
- strbufs has some invariants that are very important to keep in mind:
+ strbufs have some invariants that are very important to keep in mind:
. The `buf` member is never NULL, so it can be used in any usual C
string operations safely. strbuf's _have_ to be initialized either by
* `struct strbuf`
This is the string buffer structure. The `len` member can be used to
- determine the current length of the string, and `buf` member provides access to
- the string itself.
+ determine the current length of the string, and `buf` member provides
+ access to the string itself.
Functions
---------
* Related to the contents of the buffer
+`strbuf_trim`::
+
+ Strip whitespace from the beginning and end of a string.
+ Equivalent to performing `strbuf_rtrim()` followed by `strbuf_ltrim()`.
+
`strbuf_rtrim`::
Strip whitespace from the end of a string.
+`strbuf_ltrim`::
+
+ Strip whitespace from the beginning of a string.
+
+`strbuf_reencode`::
+
+ Replace the contents of the strbuf with a reencoded form. Returns -1
+ on error, 0 on success.
+
+`strbuf_tolower`::
+
+ Lowercase each character in the buffer using `tolower`.
+
`strbuf_cmp`::
Compare two buffers. Returns an integer less than, equal to, or greater
`strbuf_addbuf`::
- Copy the contents of an other buffer at the end of the current one.
+ Copy the contents of another buffer at the end of the current one.
`strbuf_adddup`::