ExternalVendorCode/serval-dna
1
0
Fork 0
mirror of https://github.com/servalproject/serval-dna.git synced 2024-12-24 07:16:43 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add strbuf_remaining()

Browse Source 
Improve some comments in strbuf.h
This commit is contained in:
Andrew Bettison 2013-04-04 17:41:18 +10:30
parent c6666387e8
commit 10e89c7438
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
strbuf.h
View File

@ -231,8 +231,8 @@ strbuf strbuf_reset(strbuf sb);
* truncating if necessary to avoid buffer overrun, and terminating with a nul
* which is not counted in the maximum. Return a pointer to the strbuf so that
* concatenations can be chained in a single line: eg,
* strbuf_ncat(strbuf_ncat(sb, "abc", 1), "bcd", 2) gives a strbuf containing
* "abc";
* strbuf_ncat(strbuf_ncat(sb, "abc", 1), "def", 2) gives a strbuf containing
* "ade";
*
* After these operations:
* n = strbuf_len(sb);
@ -396,7 +396,8 @@ __STRBUF_INLINE size_t strbuf_is_empty(const_strbuf sb) {
}
/** Return the size of the backing buffer.
/** Return the size of the backing buffer. Return -1 if the buffer is of
* undefined size.
*
* This is the same as the 'size' argument passed to the most recent
* strbuf_init().
@ -420,6 +421,17 @@ __STRBUF_INLINE size_t strbuf_len(const_strbuf sb) {
}
/** Return remaining space in the strbuf, not counting the terminating nul. Return
* the maximum possible size_t value if the strbuf is of undefined size.
*
* Invariant: strbuf_size(sb) == -1 || strbuf_remaining(sb) == strbuf_size(sb) - strbuf_len(sb)
*
* @author Andrew Bettison <andrew@servalproject.com>
*/
__STRBUF_INLINE size_t strbuf_remaining(const_strbuf sb) {
return sb->end ? sb->end - strbuf_end(sb) : ~(size_t)0;
}
/** Return the number of chars appended to the strbuf so far, not counting the
* terminating nul.
*