stream_adapters_api.h

Go to the documentation of this file.

/* SPDX-License-Identifier: GPL-3.0-or-later
 * Copyright (C) 2026 Sylvain Labopin
 */
 
#ifndef LEXLEO_STREAM_ADAPTERS_API_H
#define LEXLEO_STREAM_ADAPTERS_API_H
 
#include "stream/borrowers/stream_types.h"
#include "stream/adapters/stream_env.h"
 
#include "policy/lexleo_cstd_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef size_t (*stream_read_fn_t)(
    void *backend,
    void *buf,
    size_t n,
    stream_status_t *st);
 
typedef size_t (*stream_write_fn_t)(
    void *backend,
    const void *buf,
    size_t n,
    stream_status_t *st);
 
typedef stream_status_t (*stream_flush_fn_t)(void *backend);
 
typedef stream_status_t (*stream_close_fn_t)(void *backend);
 
typedef struct stream_vtbl_t {
    stream_read_fn_t read;
 
    stream_write_fn_t write;
 
    stream_flush_fn_t flush;
 
    stream_close_fn_t close;
} stream_vtbl_t;
 
stream_status_t stream_create(
    stream_t **out,
    const stream_vtbl_t *vtbl,
    void *backend,
    const stream_env_t *env);
 
#ifdef __cplusplus
}
#endif
 
#endif // LEXLEO_STREAM_ADAPTERS_API_H