MirrorHub/construct
0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-12-28 00:14:07 +01:00
Code Issues Releases Wiki Activity

ircd: Update README with assert() related.

Browse source
This commit is contained in:
Jason Volk 2018-01-01 02:42:52 -07:00
parent acc73957f8
commit 864249febb
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
include/ircd/README.md
View file

@ -61,5 +61,13 @@ to move *back* to `strn*` style but it's not prudent at this time.
- Anything named `print*` like `print(mutable_buffer, T)` always composes null - Anything named `print*` like `print(mutable_buffer, T)` always composes null
terminated output into the buffer. These functions usually return a size_t terminated output into the buffer. These functions usually return a size_t
which indicates characters printed *not including null*. They may return a which count characters printed *not including null*. They may return a
`string_view`/`const_buffer` of that size (never viewing the null). `string_view`/`const_buffer` of that size (never viewing the null).
#### assert() volatility
- Consider any code inside a runtime `assert()` statement to **entirely**
disappear in optimized builds. Some implementations of `assert()` may only
elide the boolean check and thus preserve the inner statement and the effects
of its execution. We do not rely on this. Consider `assert()` to be a
preprocessor macro like assert(*actual characters entirely erased*).