comparison: docs/Writerside/topics/buffer.h.md
docs/Writerside/topics/buffer.h.md
- changeset 1190
- a7b913d5d589
- parent 1146
- 151c057faf7c
equal
deleted
inserted
replaced
| 1188:b0300de92b72 | 1190:a7b913d5d589 |
|---|---|
| 1 # Buffer | 1 # Buffer |
| 2 | 2 |
| 3 <warning> | 3 <warning> |
| 4 Outdated - Rewrite! | 4 Outdated Section - will be updated soon! |
| 5 </warning> | 5 </warning> |
| 6 | 6 |
| 7 Instances of this buffer implementation can be used to read from or write to memory like you would do with a stream. | 7 Instances of this buffer implementation can be used to read from or write to memory like you would do with a stream. |
| 8 This allows the use of `cx_stream_copy()` (see [](streams.h.md)) to copy contents from one buffer to another, | 8 This allows the use of `cx_stream_copy()` (see [](streams.h.md)) to copy contents from one buffer to another, |
| 9 or from a file or network streams to the buffer and vice-versa. | 9 or from a file or network streams to the buffer and vice versa. |
| 10 | 10 |
| 11 More features for convenient use of the buffer can be enabled, like automatic memory management and automatic | 11 More features for convenient use of the buffer can be enabled, like automatic memory management and automatic |
| 12 resizing of the buffer space. | 12 resizing of the buffer space. |
| 13 | 13 |
| 14 Since UCX 3.0, the buffer also supports automatic flushing of contents to another stream (or buffer) as an alternative | 14 Since UCX 3.0, the buffer also supports automatic flushing of contents to another stream (or buffer) as an alternative |
| 15 to automatically resizing the buffer space. | 15 to automatically resizing the buffer space. |
| 16 Please refer to the API doc for the fields prefixed with `flush_` to learn more. | 16 Please refer to the API doc for the fields prefixed with `flush_` to learn more. |
| 17 | 17 |
| 18 <!-- | |
| 18 ## Undocumented Symbols (TODO) | 19 ## Undocumented Symbols (TODO) |
| 19 ### cxBufferAppend | 20 ### cxBufferAppend |
| 20 ### cxBufferClear | 21 ### cxBufferClear |
| 21 ### cxBufferCreate | 22 ### cxBufferCreate |
| 22 ### cxBufferDestroy | 23 ### cxBufferDestroy |
| 35 ### cxBufferShift | 36 ### cxBufferShift |
| 36 ### cxBufferShiftLeft | 37 ### cxBufferShiftLeft |
| 37 ### cxBufferShiftRight | 38 ### cxBufferShiftRight |
| 38 ### cxBufferTerminate | 39 ### cxBufferTerminate |
| 39 ### cxBufferWrite | 40 ### cxBufferWrite |
| 41 --> | |
| 42 | |
| 43 <seealso> | |
| 44 <category ref="apidoc"> | |
| 45 <a href="https://ucx.sourceforge.io/api/buffer_8h.html">buffer.h</a> | |
| 46 </category> | |
| 47 </seealso> |
