stream.h

Go to the documentation of this file.

#ifndef BJ_STREAM_H
#define BJ_STREAM_H
 
#include <banjo/api.h>
#include <banjo/error.h>

struct bj_stream;

enum bj_seek_origin {
    BJ_SEEK_BEGIN   = 0x00, 
    BJ_SEEK_CURRENT = 0x01, 
    BJ_SEEK_END     = 0x02, 
};
 

BANJO_EXPORT struct bj_stream* bj_allocate_stream(
    void
);

BANJO_EXPORT struct bj_stream* bj_open_stream_read(
    const void* data,
    size_t length
);

BANJO_EXPORT struct bj_stream* bj_open_stream_file(
    const char*       path,
    struct bj_error**        error
);

BANJO_EXPORT void bj_close_stream(
    struct bj_stream* stream
);

BANJO_EXPORT size_t bj_read_stream(
    struct bj_stream* stream,
    void* dest,
    size_t count
);

BANJO_EXPORT size_t bj_get_stream_length(
    struct bj_stream* stream
);

BANJO_EXPORT size_t bj_seek_stream(
    struct bj_stream* stream,
    ptrdiff_t position,
    enum bj_seek_origin from
);

BANJO_EXPORT size_t bj_tell_stream(
    struct bj_stream* stream
);

#define bj_stream_read_t(stream, type, buffer) bj_read_stream(stream, buffer, sizeof(type))

#define bj_stream_skip_t(stream, type) bj_read_stream(stream, 0, sizeof(type))
 
#endif