dynamic_buffer.h v0.2.2
Reference-counted byte buffer library for efficient I/O operations
Loading...
Searching...
No Matches
Functions
I/O Operations

Functions for reading and writing buffers. More...

Functions

DB_DEF ssize_t db_read_fd (db_buffer *buf_ptr, int fd, size_t max_bytes)
 Read data from file descriptor into buffer.
 
DB_DEF ssize_t db_write_fd (db_buffer buf, int fd)
 Write buffer contents to file descriptor.
 
DB_DEF db_buffer db_read_file (const char *filename)
 Read entire file into a new buffer.
 
DB_DEF bool db_write_file (db_buffer buf, const char *filename)
 Write buffer contents to file.
 

Detailed Description

Functions for reading and writing buffers.

Function Documentation

◆ db_read_fd()

DB_DEF ssize_t db_read_fd ( db_buffer buf_ptr,
int  fd,
size_t  max_bytes 
)

Read data from file descriptor into buffer.

Parameters
buf_ptrPointer to buffer (must not be NULL)
fdFile descriptor to read from
max_bytesMaximum bytes to read (0 for no limit)
Returns
Number of bytes read, or -1 on error
Note
Buffer will be resized as needed to accommodate data

◆ db_read_file()

DB_DEF db_buffer db_read_file ( const char *  filename)

Read entire file into a new buffer.

Parameters
filenamePath to file to read
Returns
New buffer containing file contents, or NULL if file cannot be read

◆ db_write_fd()

DB_DEF ssize_t db_write_fd ( db_buffer  buf,
int  fd 
)

Write buffer contents to file descriptor.

Parameters
bufSource buffer (must not be NULL)
fdFile descriptor to write to
Returns
Number of bytes written, or -1 on error

◆ db_write_file()

DB_DEF bool db_write_file ( db_buffer  buf,
const char *  filename 
)

Write buffer contents to file.

Parameters
bufSource buffer (must not be NULL)
filenamePath to file to write
Returns
true on success, false on failure