rbuf_rdonly(3)

Usage

#include <roy.h>

int rbuf_rdonly (RBuf *buf);

void rbuf_set_rdonly (RBuf *buf);

void rbuf_set_rdwr (RBuf *buf);

Overview

If buf is set read-only no api call can modify its buffer. An rbuf marked read-only can still be freed. Rbufs created by rbuf_auto(3) and rbuf_new_with_static(3) are automaticaly set to read-only and its highly recommened that the programmer not change them to be read-write.

A call to rbuf_rdonly(3) will see buf is already set read-only.

A call to rbuf_set_rdonly(3) will set buf read-only. This does not mean that buf is now static, so a call to rbuf_free(3) on buf will free buf, including its buffer.

A call to rbuf_set_rdwr(3) will set buf read-write. Its highly recommened that programmers do not call this on rbufs created with rbuf_auto(3) or rbuf_new_with_static(3).

Return value

A call to rbuf_rdonly(3) returns TRUE if buf is a read-only rbuf. If buf is read-write then this call returns FALSE.

Calls to rbuf_set_rdonly(3), and rbuf_set_rdwr(3) return nothing.

Errors

These api calls never fail.

Macro

These api calls are implemented using macros.

Releases

2 releases since Debian 3.0 (Woody); the text changed 1 time.

3.0
3.1

rbuf(3) a robust string implementation rbuf_append(3) append a value to an rbuf rbuf_append_char(3) append a value to an rbuf rbuf_append_data(3) append a value to an rbuf rbuf_append_rbuf(3) append a value to an rbuf rbuf_append_sprintf(3) creating formatted rbuf's rbuf_append_str(3) append a value to an rbuf rbuf_append_vsprintf(3) creating formatted rbuf's rbuf_auto(3) create a volatile rbuf from static string rbuf_down(3) convert each character to lower case rbuf_empty(3) find out if an rbuf is holding anything rbuf_equal(3) equivalance checks for rbufs rbuf_equal_data(3) equivalance checks for rbufs rbuf_equal_rbuf(3) equivalance checks for rbufs rbuf_equal_rbuf_len(3) equivalance checks for rbufs rbuf_equal_rbufcase(3) equivalance checks for rbufs rbuf_equal_str(3) equivalance checks for rbufs rbuf_equal_str_len(3) equivalance checks for rbufs rbuf_equal_strcase(3) equivalance checks for rbufs rbuf_erase(3) remove portions of an rbuf. rbuf_float(3) get the buffer from an rbuf rbuf_long - return float value of rbuf contents. rbuf_float - return float value of rbuf contents. rbuf_free(3) free an rbuf rbuf_hash(3) string hash functions optimized for rbufs rbuf_insert(3) insert a value into an rbuf rbuf_last(3) get the last byte of an rbuf's buffer. rbuf_len(3) get the len of an rbuf rbuf_long(3) get the buffer from an rbuf rbuf_long - return float value of rbuf contents. rbuf_float - return float value of rbuf contents. rbuf_new(3) the rbuf allocation api rbuf_new_with_sprintf(3) creating formatted rbuf's rbuf_own(3) rbuf ownership rbuf_prepend(3) prepend a value to an rbuf. rbuf_prepend_char(3) prepend a value to an rbuf. rbuf_prepend_data(3) prepend a value to an rbuf. rbuf_prepend_rbuf(3) prepend a value to an rbuf. rbuf_prepend_str(3) prepend a value to an rbuf. rbuf_set_to(3) reset an rbuf to a new value rbuf_split(3) split an rbuf into an rlist of rbufs rbuf_sprintf(3) creating formatted rbuf's rbuf_str(3) get the buffer from an rbuf rbuf_long - return float value of rbuf contents. rbuf_float - return float value of rbuf contents. rbuf_truncate(3) change the length of an rbuf's buffer rbuf_up(3) convert each character to upper case roy(3) the roy library

Mentioned on this page

rbuf_new_with_static(3) rbuf_rdonly(3) get and set read-write status for an rbuf rbuf_set_rdonly(3) rbuf_set_rdwr(3)

Referred to by

rbuf(3) a robust string implementation rbuf_up(3) convert each character to upper case rbuf_len(3) get the len of an rbuf rbuf_new(3) the rbuf allocation api rbuf_own(3) rbuf ownership rbuf_str(3) get the buffer from an rbuf rbuf_long - return float value of rbuf contents. rbuf_float - return float value of rbuf contents. rbuf_auto(3) create a volatile rbuf from static string rbuf_down(3) convert each character to lower case rbuf_free(3) free an rbuf rbuf_hash(3) string hash functions optimized for rbufs rbuf_last(3) get the last byte of an rbuf's buffer. rbuf_long(3) get the buffer from an rbuf rbuf_long - return float value of rbuf contents. rbuf_float - return float value of rbuf contents. rbuf_empty(3) find out if an rbuf is holding anything rbuf_equal(3) equivalance checks for rbufs rbuf_erase(3) remove portions of an rbuf. rbuf_float(3) get the buffer from an rbuf rbuf_long - return float value of rbuf contents. rbuf_float - return float value of rbuf contents. rbuf_split(3) split an rbuf into an rlist of rbufs rbuf_append(3) append a value to an rbuf rbuf_insert(3) insert a value into an rbuf rbuf_set_to(3) reset an rbuf to a new value rbuf_prepend(3) prepend a value to an rbuf. rbuf_sprintf(3) creating formatted rbuf's rbuf_truncate(3) change the length of an rbuf's buffer rbuf_equal_str(3) equivalance checks for rbufs rbuf_append_str(3) append a value to an rbuf rbuf_equal_data(3) equivalance checks for rbufs rbuf_equal_rbuf(3) equivalance checks for rbufs rbuf_append_char(3) append a value to an rbuf rbuf_append_data(3) append a value to an rbuf rbuf_append_rbuf(3) append a value to an rbuf rbuf_prepend_str(3) prepend a value to an rbuf. rbuf_prepend_char(3) prepend a value to an rbuf. rbuf_prepend_data(3) prepend a value to an rbuf. rbuf_prepend_rbuf(3) prepend a value to an rbuf. rbuf_equal_str_len(3) equivalance checks for rbufs rbuf_equal_strcase(3) equivalance checks for rbufs rbuf_append_sprintf(3) creating formatted rbuf's rbuf_equal_rbuf_len(3) equivalance checks for rbufs rbuf_equal_rbufcase(3) equivalance checks for rbufs rbuf_append_vsprintf(3) creating formatted rbuf's rbuf_new_with_sprintf(3) creating formatted rbuf's