LexLeo 0.0.0-dev+f8e5087-dirty
Technical documentation
Loading...
Searching...
No Matches
fs_stream_cr_api.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: GPL-3.0-or-later
2 * Copyright (C) 2026 Sylvain Labopin
3 */
4
19#ifndef LEXLEO_FS_STREAM_CR_API_H
20#define LEXLEO_FS_STREAM_CR_API_H
21
23
28
30
31#ifdef __cplusplus
32extern "C" {
33#endif
34
46
70 const osal_file_env_t *file_env,
71 const osal_file_ops_t *file_ops,
72 const stream_env_t *port_env);
73
123 stream_t **out,
124 const fs_stream_args_t *args,
125 const fs_stream_cfg_t *cfg,
126 const fs_stream_env_t *env);
127
173 stream_key_t key,
174 const fs_stream_cfg_t *cfg,
175 const fs_stream_env_t *env,
176 const osal_mem_ops_t *mem);
177
178#ifdef __cplusplus
179}
180#endif
181
182#endif // LEXLEO_FS_STREAM_CR_API_H
stream_status_t fs_stream_create_stream(stream_t **out, const fs_stream_args_t *args, const fs_stream_cfg_t *cfg, const fs_stream_env_t *env)
Create a file-backed stream instance.
Definition fs_stream.c:208
fs_stream_cfg_t fs_stream_default_cfg(void)
Return a default configuration for the fs_stream adapter.
Definition fs_stream.c:294
stream_status_t fs_stream_create_desc(stream_adapter_desc_t *out, stream_key_t key, const fs_stream_cfg_t *cfg, const fs_stream_env_t *env, const osal_mem_ops_t *mem)
Build an adapter descriptor for registering fs_stream in a factory.
Definition fs_stream.c:256
fs_stream_env_t fs_stream_default_env(const osal_file_env_t *file_env, const osal_file_ops_t *file_ops, const stream_env_t *port_env)
Build a default environment for the fs_stream adapter.
Definition fs_stream.c:298
Types used by the fs_stream Composition Root API.
Adapter-side API for constructing and binding stream_t objects.
Adapter installation contracts for the stream port.
Public key type used to identify stream adapters.
const char * stream_key_t
Public identifier type for a registered stream adapter.
Borrower-visible public types for the stream port.
stream_status_t
Public status codes used by the stream port.
Arguments provided when creating a file-backed stream.
Configuration type for the fs_stream adapter.
Injected dependencies for the fs_stream adapter.
Public descriptor used to register a concrete stream adapter.
Runtime environment for the stream port.
Definition stream_env.h:35
Private handle structure for a stream_t.