diff --git a/docs/README.md b/docs/README.md index 7bc75954..07bd84aa 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1354,12 +1354,17 @@ Usage example: ## IO Buffers +IO buffer, described by the `struct mg_iobuf`, is a simple data structure +that insert or delete chunks of data at arbitrary offsets and grow/shrink +automatically. + ### struct mg\_iobuf ```c struct mg_iobuf { - unsigned char *buf; - size_t size, len; + unsigned char *buf; // Pointer to stored data + size_t size; // Total size available + size_t len; // Current number of bytes }; ``` diff --git a/mongoose.h b/mongoose.h index 11199337..59c89101 100644 --- a/mongoose.h +++ b/mongoose.h @@ -628,7 +628,7 @@ const char *mg_url_uri(const char *url); #include struct mg_iobuf { - unsigned char *buf; // Data + unsigned char *buf; // Pointer to stored data size_t size; // Total size available size_t len; // Current number of bytes }; diff --git a/src/iobuf.h b/src/iobuf.h index c456e3be..2c5b09fc 100644 --- a/src/iobuf.h +++ b/src/iobuf.h @@ -3,7 +3,7 @@ #include struct mg_iobuf { - unsigned char *buf; // Data + unsigned char *buf; // Pointer to stored data size_t size; // Total size available size_t len; // Current number of bytes };