# HG changeset patch # User Mike Becker # Date 1741687819 -3600 # Node ID bbb734f733920ede44418848c86038df63e3494b # Parent ebcc08023c33984febedcf3ab45f633471285fc7 downgrade info regarding stream_copy from warning to note relates to #451 diff -r ebcc08023c33 -r bbb734f73392 docs/Writerside/topics/streams.h.md --- a/docs/Writerside/topics/streams.h.md Mon Mar 10 17:03:26 2025 +0100 +++ b/docs/Writerside/topics/streams.h.md Tue Mar 11 11:10:19 2025 +0100 @@ -37,15 +37,14 @@ (and the same is true for `cx_stream_bncopy()` and `cx_stream_bcopy()`). - -When you are reading from a stream where you cannot track the position, there is the possibility that -data gets lost when the destination does not accept all the bytes read from the source. -While the stream copy functions do report how many bytes were successfully copied -to the destination, this might - in certain cases - not be the exact number of read items. - -To mitigate the risk, you should make sure that the destination can always accept all read bytes and -a possible bottleneck is only introduced by the source. - +> When you are reading from a stream where you cannot track the position, there is the possibility that +> data gets lost when the destination does not accept all the bytes read from the source. +> While the stream copy functions do report how many bytes were _successfully_ copied +> to the destination, this might - in certain cases - not be the exact number of read items. +> +> To mitigate the risk, you should make sure that the destination can always accept all read bytes and +> a possible bottleneck is only introduced by the source. +>{style="note"} > The size of the internal _stack_ buffer in `cx_stream_copy()` and `cx_stream_ncopy()` can be > set during compilation via the `CX_STREAM_COPY_BUF_SIZE` macro.