Base module
basic::Encoder
Abstract interface for stream encoders.
Encoder
#include <icy/interface.h>Abstract interface for stream encoders.
Public Methods
| Return | Name | Description |
|---|---|---|
Encoder | Defaulted constructor. | |
ssize_t | encode | Encodes nread bytes from inbuf and writes encoded output to outbuf. |
ssize_t | finalize virtual inline | Flushes any buffered state and writes final output to outbuf. |
Encoder
Encoder() = defaultDefaulted constructor.
encode
ssize_t encode(const char * inbuf, size_t nread, char * outbuf)Encodes nread bytes from inbuf and writes encoded output to outbuf.
Parameters
inbufRaw input buffer to encode.nreadNumber of bytes to encode from inbuf.outbufDestination buffer for encoded output.
Returns
Number of bytes written to outbuf, or -1 on error.
finalize
virtual inline
virtual inline ssize_t finalize(char * outbuf)Flushes any buffered state and writes final output to outbuf.
Parameters
outbufDestination buffer for any remaining output.
Returns
Number of bytes written, or 0 if nothing to flush.
