commit 32fcc834d5dae7b24eb6a71fd5fc5e1194b33c2d
parent 506ee9675944d778be3e35bc8785971f0df54aed
Author: Alexandre Bique <bique.alexandre@gmail.com>
Date: Fri, 27 May 2022 11:10:59 +0200
doc
Diffstat:
1 file changed, 2 insertions(+), 5 deletions(-)
diff --git a/include/clap/stream.h b/include/clap/stream.h
@@ -10,17 +10,14 @@ extern "C" {
typedef struct clap_istream {
void *ctx; // reserved pointer for the stream
- /* returns the number of bytes read.
- * 0 for end of file.
- * -1 on error. */
+ // returns the number of bytes read; 0 indicates end of file and -1 a read error
int64_t (*read)(const struct clap_istream *stream, void *buffer, uint64_t size);
} clap_istream_t;
typedef struct clap_ostream {
void *ctx; // reserved pointer for the stream
- /* returns the number of bytes written.
- * -1 on error. */
+ // returns the number of bytes written; -1 on write error
int64_t (*write)(const struct clap_ostream *stream, const void *buffer, uint64_t size);
} clap_ostream_t;