docs/Writerside/topics/buffer.h.md@a06a2d27c043 (annotated)
docs/Writerside/topics/buffer.h.md
Thu, 23 Jan 2025 01:33:36 +0100
- author
- Mike Becker <universe@uap-core.de>
- date
- Thu, 23 Jan 2025 01:33:36 +0100
- branch
- docs/3.1
- changeset 1141
- a06a2d27c043
- child 1142
- 9437530176bc
- permissions
- -rw-r--r--
create new page structure
relates to #451
| 1141 | 1 | # buffer.h |
| 2 | ||
| 3 | Instances of this buffer implementation can be used to read from or write to memory like you would do with a stream. | |
| 4 | This allows the use of `cx_stream_copy()` (see [Utilities](#utilities)) to copy contents from one buffer to another, | |
| 5 | or from a file or network streams to the buffer and vice-versa. | |
| 6 | ||
| 7 | More features for convenient use of the buffer can be enabled, like automatic memory management and automatic | |
| 8 | resizing of the buffer space. | |
| 9 | ||
| 10 | Since UCX 3.0, the buffer also supports automatic flushing of contents to another stream (or buffer) as an alternative | |
| 11 | to automatically resizing the buffer space. | |
| 12 | Please refer to the API doc for the fields prefixed with `flush_` to learn more. |
