comparison: docs/Writerside/topics/buffer.h.md
docs/Writerside/topics/buffer.h.md
- changeset 1188
- b0300de92b72
- parent 1146
- 151c057faf7c
- child 1190
- a7b913d5d589
equal
deleted
inserted
replaced
| 1187:0f70bb04f7ba | 1188:b0300de92b72 |
|---|---|
| 1 # Buffer | |
| 2 | |
| 3 <warning> | |
| 4 Outdated - Rewrite! | |
| 5 </warning> | |
| 6 | |
| 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, | |
| 9 or from a file or network streams to the buffer and vice-versa. | |
| 10 | |
| 11 More features for convenient use of the buffer can be enabled, like automatic memory management and automatic | |
| 12 resizing of the buffer space. | |
| 13 | |
| 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. | |
| 16 Please refer to the API doc for the fields prefixed with `flush_` to learn more. | |
| 17 | |
| 18 ## Undocumented Symbols (TODO) | |
| 19 ### cxBufferAppend | |
| 20 ### cxBufferClear | |
| 21 ### cxBufferCreate | |
| 22 ### cxBufferDestroy | |
| 23 ### cxBufferEnableFlushing | |
| 24 ### cxBufferEof | |
| 25 ### cxBufferFlush | |
| 26 ### cxBufferFree | |
| 27 ### cxBufferGet | |
| 28 ### cxBufferInit | |
| 29 ### cxBufferMinimumCapacity | |
| 30 ### cxBufferPut | |
| 31 ### cxBufferPutString | |
| 32 ### cxBufferRead | |
| 33 ### cxBufferReset | |
| 34 ### cxBufferSeek | |
| 35 ### cxBufferShift | |
| 36 ### cxBufferShiftLeft | |
| 37 ### cxBufferShiftRight | |
| 38 ### cxBufferTerminate | |
| 39 ### cxBufferWrite |
