reader.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2026 Thomas Ascher <thomas.ascher@gmx.at>
 *
 * SPDX-License-Identifier: MIT
 */

 
#ifndef SDFIO_READER_H
#define SDFIO_READER_H
 
#include <sdfio/header.h>
#include <sdfio/layout.h>
#include <sdfio/sdfio_export.h>
#include <sdfio/types.h>
 
#include <stddef.h>
 
#ifdef __cplusplus
extern "C"
{
#endif

typedef struct sdfio_reader sdfio_reader;

SDFIO_API sdfio_status sdfio_reader_create(const sdfio_allocator *allocator,
                                           sdfio_reader **reader);

SDFIO_API sdfio_status sdfio_reader_add_binary(sdfio_reader *reader);

SDFIO_API sdfio_status sdfio_reader_add_ascii(sdfio_reader *reader);

SDFIO_API sdfio_status sdfio_reader_set_buffer(sdfio_reader *reader,
                                               size_t size);

SDFIO_API sdfio_status sdfio_reader_set_chunk(sdfio_reader *reader,
                                              size_t count);

SDFIO_API sdfio_status sdfio_reader_set_time_zone(
    sdfio_reader *reader, const sdfio_time_zone *time_zone);

SDFIO_API size_t sdfio_reader_magic_count(const sdfio_reader *reader);

SDFIO_API const char *sdfio_reader_magic(const sdfio_reader *reader,
                                         size_t index);

SDFIO_API sdfio_status sdfio_reader_reset(sdfio_reader *reader);

SDFIO_API void sdfio_reader_free(sdfio_reader *reader);

SDFIO_API sdfio_status sdfio_open_memory(sdfio_reader *reader, const void *data,
                                         size_t size);

SDFIO_API sdfio_status sdfio_open_stream(sdfio_reader *reader,
                                         const sdfio_stream *stream);

SDFIO_API const sdfio_header *sdfio_reader_header(const sdfio_reader *reader);

SDFIO_API sdfio_status sdfio_read_data(sdfio_reader *reader,
                                       const sdfio_layout *layout, void *dst,
                                       size_t rows);

SDFIO_API sdfio_status sdfio_read_heights(sdfio_reader *reader,
                                          const sdfio_layout *layout,
                                          void *dst);

SDFIO_API sdfio_status sdfio_read_trailer(sdfio_reader *reader, char *buffer,
                                          size_t capacity, size_t *size);

SDFIO_API const char *sdfio_reader_error_message(const sdfio_reader *reader);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SDFIO_READER_H */