diff -r 0f70bb04f7ba -r b0300de92b72 docs/Writerside/topics/buffer.h.md --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/Writerside/topics/buffer.h.md Tue Feb 11 19:55:32 2025 +0100 @@ -0,0 +1,39 @@ +# Buffer + + +Outdated - Rewrite! + + +Instances of this buffer implementation can be used to read from or write to memory like you would do with a stream. +This allows the use of `cx_stream_copy()` (see [](streams.h.md)) to copy contents from one buffer to another, +or from a file or network streams to the buffer and vice-versa. + +More features for convenient use of the buffer can be enabled, like automatic memory management and automatic +resizing of the buffer space. + +Since UCX 3.0, the buffer also supports automatic flushing of contents to another stream (or buffer) as an alternative +to automatically resizing the buffer space. +Please refer to the API doc for the fields prefixed with `flush_` to learn more. + +## Undocumented Symbols (TODO) +### cxBufferAppend +### cxBufferClear +### cxBufferCreate +### cxBufferDestroy +### cxBufferEnableFlushing +### cxBufferEof +### cxBufferFlush +### cxBufferFree +### cxBufferGet +### cxBufferInit +### cxBufferMinimumCapacity +### cxBufferPut +### cxBufferPutString +### cxBufferRead +### cxBufferReset +### cxBufferSeek +### cxBufferShift +### cxBufferShiftLeft +### cxBufferShiftRight +### cxBufferTerminate +### cxBufferWrite