fixed bad typedef name in .h

Ondřej Hruška 9 years ago
parent 0fb32781c9
commit 350ae15db5
  1. 2
  2. 34

@ -12,7 +12,7 @@ Usage
uint8_t buffer[32]; // array backing the buffer
CircularByteBuffer cb; // buffer instance
CircularBuffer cb; // buffer instance
void main()

@ -8,67 +8,67 @@ typedef struct {
uint16_t read_pos;
uint16_t write_pos;
uint16_t data_len;
} CircularByteBuffer;
} CircularBuffer;
/** Init a buffer */
void cbuf_init(CircularByteBuffer *inst, uint8_t *buffer, uint16_t length);
void cbuf_init(CircularBuffer *inst, uint8_t *buffer, uint16_t length);
/** Test for full buffer */
bool cbuf_full(CircularByteBuffer *inst);
bool cbuf_full(CircularBuffer *inst);
/** Test for empty buffer */
bool cbuf_empty(CircularByteBuffer *inst);
bool cbuf_empty(CircularBuffer *inst);
/** Write a byte to buffer, returns success */
bool cbuf_write(CircularByteBuffer *inst, uint8_t b);
bool cbuf_write(CircularBuffer *inst, uint8_t b);
/** Read a byte from the buffer, return susccess */
bool cbuf_read(CircularByteBuffer *inst, uint8_t *b);
bool cbuf_read(CircularBuffer *inst, uint8_t *b);
/** Get byte at the read cursor, without incrementing it. False on empty. */
bool cbuf_peek(CircularByteBuffer *inst, uint8_t *b);
bool cbuf_peek(CircularBuffer *inst, uint8_t *b);
/** Get data count */
uint16_t cbuf_data_size(CircularByteBuffer *inst);
uint16_t cbuf_data_size(CircularBuffer *inst);
/** Get free space in the buffer */
uint16_t cbuf_free_space(CircularByteBuffer *inst);
uint16_t cbuf_free_space(CircularBuffer *inst);
/** Remove all data from buffer */
void cbuf_clear(CircularByteBuffer *inst);
void cbuf_clear(CircularBuffer *inst);
/** Write N bytes. Returns success */
bool cbuf_write_n(CircularByteBuffer *inst, const uint8_t *b, uint16_t count);
bool cbuf_write_n(CircularBuffer *inst, const uint8_t *b, uint16_t count);
/** Write a string (without \0) */
bool cbuf_write_string(CircularByteBuffer *inst, const char *str);
bool cbuf_write_string(CircularBuffer *inst, const char *str);
/** Read N bytes, if available. Returns success. */
bool cbuf_read_n(CircularByteBuffer *inst, uint8_t *buf, uint16_t len);
bool cbuf_read_n(CircularBuffer *inst, uint8_t *buf, uint16_t len);
/** Read string of given length, append \0. `str` must be len+1 long */
bool cbuf_read_string(CircularByteBuffer *inst, char *str, uint16_t len);
bool cbuf_read_string(CircularBuffer *inst, char *str, uint16_t len);
/** Read up to N bytes. Returns byte count */
uint16_t cbuf_read_upto(CircularByteBuffer *inst, uint8_t *buf, uint16_t max);
uint16_t cbuf_read_upto(CircularBuffer *inst, uint8_t *buf, uint16_t max);
/** Read string up to N chars long, append \0. `str` must be max+1 long */
uint16_t cbuf_read_string_upto(CircularByteBuffer *inst, char *str, uint16_t max);
uint16_t cbuf_read_string_upto(CircularBuffer *inst, char *str, uint16_t max);
@ -76,4 +76,4 @@ uint16_t cbuf_read_string_upto(CircularByteBuffer *inst, char *str, uint16_t max
* of the given byte (position relative to read_pos).
* Returns -1 if not found.
int32_t cbuf_find(CircularByteBuffer *inst, uint8_t b);
int32_t cbuf_find(CircularBuffer *inst, uint8_t b);