sapi_buffer.h

Go to the documentation of this file.

#ifndef SAFEAPI_COMMON_BUFFER_H
#define SAFEAPI_COMMON_BUFFER_H
 
#include "safeapi/utils/status/sapi_status.h"
#include "safeapi/utils/types/sapi_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct sapi_buffer_s
{
    void   *data;      
    size_t  capacity;  
    size_t  length;    
} sapi_buffer_t;

typedef struct sapi_const_buffer_s
{
    const void *data;    
    size_t      length;  
} sapi_const_buffer_t;

sapi_status_t sapi_buffer_init(sapi_buffer_t *buf, void *storage, size_t capacity);

sapi_status_t sapi_buffer_clear(sapi_buffer_t *buf);

sapi_status_t sapi_buffer_set_length(sapi_buffer_t *buf, size_t length);

sapi_status_t sapi_buffer_copy_in(sapi_buffer_t *buf, const void *src, size_t src_len);

sapi_status_t sapi_buffer_copy_out(const sapi_buffer_t *buf,
                                    void *dest,
                                    size_t dest_capacity,
                                    size_t *out_copied);

sapi_status_t sapi_buffer_as_const(const sapi_buffer_t *buf, sapi_const_buffer_t *out_view);

bool sapi_buffer_is_valid(const sapi_buffer_t *buf);
 
/*
 * Endianness-safe multi-byte access (ADR-006 section 2.5). Byte order is
 * always explicit at the call site (_le / _be suffix) - there is no
 * default/"network order" variant. write_* functions append at buf's
 * current length and advance it, like sapi_buffer_copy_in(); read_*
 * functions take an explicit offset and do not mutate the buffer, like
 * sapi_buffer_copy_out().
 */

sapi_status_t sapi_buffer_write_u16_le(sapi_buffer_t *buf, uint16_t value);
sapi_status_t sapi_buffer_write_u16_be(sapi_buffer_t *buf, uint16_t value);
sapi_status_t sapi_buffer_write_u32_le(sapi_buffer_t *buf, uint32_t value);
sapi_status_t sapi_buffer_write_u32_be(sapi_buffer_t *buf, uint32_t value);
sapi_status_t sapi_buffer_write_u64_le(sapi_buffer_t *buf, uint64_t value);
sapi_status_t sapi_buffer_write_u64_be(sapi_buffer_t *buf, uint64_t value);

sapi_status_t sapi_buffer_read_u16_le(const sapi_buffer_t *buf, size_t offset, uint16_t *out_value);
sapi_status_t sapi_buffer_read_u16_be(const sapi_buffer_t *buf, size_t offset, uint16_t *out_value);
sapi_status_t sapi_buffer_read_u32_le(const sapi_buffer_t *buf, size_t offset, uint32_t *out_value);
sapi_status_t sapi_buffer_read_u32_be(const sapi_buffer_t *buf, size_t offset, uint32_t *out_value);
sapi_status_t sapi_buffer_read_u64_le(const sapi_buffer_t *buf, size_t offset, uint64_t *out_value);
sapi_status_t sapi_buffer_read_u64_be(const sapi_buffer_t *buf, size_t offset, uint64_t *out_value);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SAFEAPI_COMMON_BUFFER_H */
 /* BUFFER */