ring_buffer.h

Go to the documentation of this file.

#pragma once
 
#include "macro.h"
#include "memory/allocator.h"
#include "nostd.h"
#include "object/destructor.h"
#include "object/optional.h"
#include "object/result.h"
#include "utility.h"
#include <stdbool.h>
#include <stddef.h>
 
typedef struct {
  cu_Slice_Optional data;            
  size_t capacity;                   
  size_t head;                       
  size_t length;                     
  cu_Layout layout;                  
  cu_Allocator allocator;            
  cu_Destructor_Optional destructor; 
} cu_RingBuffer;
 
typedef enum {
  CU_RINGBUFFER_ERROR_NONE = 0,
  CU_RINGBUFFER_ERROR_OOM,
  CU_RINGBUFFER_ERROR_INVALID_LAYOUT,
  CU_RINGBUFFER_ERROR_INVALID,
  CU_RINGBUFFER_ERROR_FULL,
  CU_RINGBUFFER_ERROR_EMPTY,
} cu_RingBuffer_Error;
 
CU_RESULT_DECL(cu_RingBuffer, cu_RingBuffer, cu_RingBuffer_Error)
CU_OPTIONAL_DECL(cu_RingBuffer_Error, cu_RingBuffer_Error)
 
cu_RingBuffer_Result cu_RingBuffer_create(cu_Allocator allocator,
    cu_Layout layout, size_t capacity, cu_Destructor_Optional destructor);
 
void cu_RingBuffer_destroy(cu_RingBuffer *rb);
 
static inline size_t cu_RingBuffer_size(const cu_RingBuffer *rb) {
  CU_IF_NULL(rb) { return 0; }
  return rb->length;
}
 
static inline size_t cu_RingBuffer_capacity(const cu_RingBuffer *rb) {
  CU_IF_NULL(rb) { return 0; }
  return rb->capacity;
}
 
static inline bool cu_RingBuffer_is_empty(const cu_RingBuffer *rb) {
  CU_IF_NULL(rb) { return true; }
  return rb->length == 0;
}
 
static inline bool cu_RingBuffer_is_full(const cu_RingBuffer *rb) {
  CU_IF_NULL(rb) { return false; }
  return rb->length == rb->capacity && rb->capacity > 0;
}
 
cu_RingBuffer_Error_Optional cu_RingBuffer_push(cu_RingBuffer *rb, void *elem);
 
cu_RingBuffer_Error_Optional cu_RingBuffer_pop(
    cu_RingBuffer *rb, void *out_elem);
 
void cu_RingBuffer_clear(cu_RingBuffer *rb);