diff options
Diffstat (limited to 'extract/include/extract_buffer.h')
-rw-r--r-- | extract/include/extract_buffer.h | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/extract/include/extract_buffer.h b/extract/include/extract_buffer.h index b0abbec3..86b9404e 100644 --- a/extract/include/extract_buffer.h +++ b/extract/include/extract_buffer.h @@ -1,6 +1,12 @@ #ifndef ARTIFEX_EXTRACT_BUFFER_H #define ARTIFEX_EXTRACT_BUFFER_H +/* Reading and writing abstractions. + +We use inline code in the common case where reading or writing can be satisfied +using a cache. +*/ + #include "extract_alloc.h" #include <stddef.h> @@ -10,12 +16,6 @@ #include "extract_compat_inline.h" #endif -/* Reading and writing abstractions. - -We use inline code in the common case where reading or writing can be satisfied -using a cache. -*/ - typedef struct extract_buffer_t extract_buffer_t; /* Abstract state for a buffer. */ @@ -27,10 +27,10 @@ static inline int extract_buffer_read( size_t numbytes, size_t* o_actual ); -/* Reads specified number of bytes from buffer into data..+bytes, making multiple calls to -the underlying extract_buffer_fn_read function until we have read <numbytes> or reached -EOF. If we reach EOF, . Returns +1 if -short read due to EOF. +/* Reads specified number of bytes from buffer into data..+bytes, making +multiple calls to the underlying extract_buffer_fn_read function until we have +read <numbytes> or reached EOF. If we reach EOF, . Returns +1 if short read due +to EOF. buffer: As returned by earlier call to extract_buffer_open(). |