docs/api-2.1/buffer_8h_source.html

 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
  * Copyright 2017 Mike Becker, Olaf Wintermann All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
  *
  *   1. Redistributions of source code must retain the above copyright
  *      notice, this list of conditions and the following disclaimer.
  *
  *   2. Redistributions in binary form must reproduce the above copyright
  *      notice, this list of conditions and the following disclaimer in the
  *      documentation and/or other materials provided with the distribution.
  *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */

 #ifndef UCX_BUFFER_H
 #define UCX_BUFFER_H

 #include "ucx.h"
 #include <sys/types.h>
 #include <stdio.h>

 #ifdef  __cplusplus
 extern "C" {
 #endif

 #define UCX_BUFFER_DEFAULT      0x00

 #define UCX_BUFFER_AUTOFREE     0x01

 #define UCX_BUFFER_AUTOEXTEND   0x02

 typedef struct {
     char *space;
     size_t pos;
     size_t capacity;
     size_t size;
     int flags;
 } UcxBuffer;

 UcxBuffer *ucx_buffer_new(void *space, size_t capacity, int flags);

 void ucx_buffer_free(UcxBuffer* buffer);

 UcxBuffer* ucx_buffer_extract(UcxBuffer *src,
         size_t start, size_t length, int flags);

 #define ucx_buffer_clone(src,flags) \
     ucx_buffer_extract(src, 0, (src)->capacity, flags)


 int ucx_buffer_shift(UcxBuffer* buffer, off_t shift);

 int ucx_buffer_shift_right(UcxBuffer* buffer, size_t shift);

 int ucx_buffer_shift_left(UcxBuffer* buffer, size_t shift);


 int ucx_buffer_seek(UcxBuffer *buffer, off_t offset, int whence);

 #define ucx_buffer_clear(buffer) memset((buffer)->space, 0, (buffer)->size); \
         (buffer)->size = 0; (buffer)->pos = 0;

 int ucx_buffer_eof(UcxBuffer *buffer);


 int ucx_buffer_extend(UcxBuffer *buffer, size_t additional_bytes);

 size_t ucx_buffer_write(const void *ptr, size_t size, size_t nitems,
         UcxBuffer *buffer);

 size_t ucx_buffer_read(void *ptr, size_t size, size_t nitems,
         UcxBuffer *buffer);

 int ucx_buffer_putc(UcxBuffer *buffer, int c);

 int ucx_buffer_getc(UcxBuffer *buffer);

 size_t ucx_buffer_puts(UcxBuffer *buffer, const char *str);

 #define ucx_buffer_to_sstr(buffer) sstrn((buffer)->space, (buffer)->size)

 #ifdef  __cplusplus
 }
 #endif

 #endif  /* UCX_BUFFER_H */

UcxBuffer::flags
int flags
Flag register for buffer features.
Definition: buffer.h:88

+ucx_buffer_seek
int ucx_buffer_seek(UcxBuffer *buffer, off_t offset, int whence)
Moves the position of the buffer.
Definition: buffer.c:90

+ucx_buffer_read
size_t ucx_buffer_read(void *ptr, size_t size, size_t nitems, UcxBuffer *buffer)
Reads data from a UcxBuffer.
Definition: buffer.c:189

+ucx_buffer_shift_left
int ucx_buffer_shift_left(UcxBuffer *buffer, size_t shift)
Shifts the buffer to the left.
Definition: buffer.c:244

+ucx.h
Main UCX Header providing most common definitions.

+ucx_buffer_extend
int ucx_buffer_extend(UcxBuffer *buffer, size_t additional_bytes)
Extends the capacity of the buffer.
Definition: buffer.c:126

+ucx_buffer_free
void ucx_buffer_free(UcxBuffer *buffer)
Destroys a buffer.
Definition: buffer.c:59

+UcxBuffer::pos
size_t pos
Current position of the buffer.
Definition: buffer.h:77

+ucx_buffer_write
size_t ucx_buffer_write(const void *ptr, size_t size, size_t nitems, UcxBuffer *buffer)
Writes data to a UcxBuffer.
Definition: buffer.c:152

+UcxBuffer::capacity
size_t capacity
Current capacity (i.e.
Definition: buffer.h:79

+UcxBuffer::space
char * space
A pointer to the buffer contents.
Definition: buffer.h:75

+ucx_buffer_eof
int ucx_buffer_eof(UcxBuffer *buffer)
Tests, if the buffer position has exceeded the buffer capacity.
Definition: buffer.c:122

+UcxBuffer
UCX Buffer.
Definition: buffer.h:73

+ucx_buffer_puts
size_t ucx_buffer_puts(UcxBuffer *buffer, const char *str)
Writes a string to a buffer.
Definition: buffer.c:240

+ucx_buffer_putc
int ucx_buffer_putc(UcxBuffer *buffer, int c)
Writes a character to a buffer.
Definition: buffer.c:210

+ucx_buffer_shift
int ucx_buffer_shift(UcxBuffer *buffer, off_t shift)
Shifts the contents of the buffer by the given offset.
Definition: buffer.c:289

+ucx_buffer_new
UcxBuffer * ucx_buffer_new(void *space, size_t capacity, int flags)
Creates a new buffer.
Definition: buffer.c:35

+ucx_buffer_extract
UcxBuffer * ucx_buffer_extract(UcxBuffer *src, size_t start, size_t length, int flags)
Creates a new buffer and fills it with extracted content from another buffer.
Definition: buffer.c:66

+UcxBuffer::size
size_t size
Current size of the buffer content.
Definition: buffer.h:81

+ucx_buffer_getc
int ucx_buffer_getc(UcxBuffer *buffer)
Gets a character from a buffer.
Definition: buffer.c:230

+ucx_buffer_shift_right
int ucx_buffer_shift_right(UcxBuffer *buffer, size_t shift)
Shifts the buffer to the right.
Definition: buffer.c:260

+