0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-12-27 07:54:05 +01:00
construct/include/ircd/buffer
Jason Volk 30796e5729 ircd::buffer: Fix template name conflicts for clang-11; apply inline linkages.
ircd::json::tuple: Fix template name related for clang-11.

ircd::ctx: Fix template related for clang-11; inline linkages.

ircd:Ⓜ️🪝 Fix template related for clang-11.
2020-10-29 04:06:59 -07:00
..
buffer.h ircd: Reorg simd.h / buffer.h interface dependency relationship. 2020-10-10 00:43:59 -07:00
buffer_base.h ircd::buffer: lte range assertion on ctor; remove attr; minor reorg. 2020-06-05 04:32:57 -07:00
const_buffer.h ircd::buffer: Add constructors which limit requested size to input buffer. 2019-12-31 11:23:20 -08:00
copy.h ircd::buffer: Remove builtin requiring constexpr size for clang-11. 2020-10-28 12:42:59 -07:00
fixed_buffer.h ircd::buffer: Fix template name conflicts for clang-11; apply inline linkages. 2020-10-29 04:06:59 -07:00
move.h ircd::buffer: Remove builtin requiring constexpr size for clang-11. 2020-10-28 12:42:59 -07:00
mutable_buffer.h ircd: Fix inlining attributes for clang-10. 2020-07-10 20:04:39 -07:00
parse_buffer.h ircd::buffer::parse_buffer: Remove erroneous cast operator. 2019-06-22 16:58:58 -06:00
README.md ircd: Start a README.md for any directory missing one; fix conformity of existing. 2019-01-26 12:29:08 -08:00
shared_buffer.h ircd::buffer: Fix template name conflicts for clang-11; apply inline linkages. 2020-10-29 04:06:59 -07:00
unique_buffer.h ircd::buffer: Fix template name conflicts for clang-11; apply inline linkages. 2020-10-29 04:06:59 -07:00
window_buffer.h ircd::buffer: lte range assertion on ctor; remove attr; minor reorg. 2020-06-05 04:32:57 -07:00

Memory Buffer Tools

This is a modernization of the (char *buf, size_t buf_sz) pattern used when working with segments of RAMs. While in C99 it is possible (and recommended) for a project to create a struct buffer { char *ptr; size_t size; }; and then manually perform object semantics buffer_copy(dst, src); buffer_move(dst, src)``buffer_free(buf); etc, we create those devices using C++ language features here instead.

This suite is born out of (though not directly based on) the boost::asio buffer objects boost::asio::const_buffer and boost::asio::mutable_buffer and the two principal objects used ubiquitously throughout IRCd share the same names and general properties. We also offer conversions between them for developers working with any asio interfaces directly.

To summarize some basics about these tools:

  • Most of these interfaces are "thin" and don't own their underlying data, nor will they copy their underlying data even if their instance itself is copied.

  • We work with signed char * (and const char *) types. We do not work with void pointers because size integers always represent a count of single bytes and there is no reason to lose or confuse that information. If unsigned char * types are required by some library function an explicit cast to uint8_t * may be required especially to avoid warnings. Note that we compile this project with -fsigned-char and don't support platforms that have incompatible conversions.