strbuf.h File Reference

String buffers. More...

Go to the source code of this file.

Data Structures
struct	nmsg_strbuf_t
	String buffer. More...

Functions
struct nmsg_strbuf *	nmsg_strbuf_init (void)
	Initialize a string buffer.
void	nmsg_strbuf_destroy (struct nmsg_strbuf **sb)
	Destroy all resources associated with a string buffer.
nmsg_res	nmsg_strbuf_append_str_json (struct nmsg_strbuf *sb, const char *str, size_t len)
	Append to a string buffer.
nmsg_res	nmsg_strbuf_append_str (struct nmsg_strbuf *sb, const char *str, size_t len)
	Append to a string buffer.
nmsg_res	nmsg_strbuf_append (struct nmsg_strbuf *sb, const char *fmt,...)
	Append formatted string to a string buffer.
nmsg_res	nmsg_strbuf_reset (struct nmsg_strbuf *sb)
	Reset a string buffer.
size_t	nmsg_strbuf_len (struct nmsg_strbuf *sb)
	Find the length of the used portion of the string buffer.

Detailed Description

String buffers.

Dynamically sized strings that may be appended to or reset.

Definition in file strbuf.h.

Function Documentation

nmsg_strbuf_init()

struct nmsg_strbuf * nmsg_strbuf_init

(

void

)

Initialize a string buffer.

Returns

Initialized string buffer, or NULL on memory allocation failure.

nmsg_strbuf_destroy()

void nmsg_strbuf_destroy

(

struct nmsg_strbuf **

sb

)

Destroy all resources associated with a string buffer.

Parameters

[in]

sb

pointer to string buffer.

nmsg_strbuf_append_str_json()

nmsg_res nmsg_strbuf_append_str_json	(	struct nmsg_strbuf *	sb,
		const char *	str,
		size_t	len
	)

Append to a string buffer.

Escape JSON special characters.

Parameters

[in]	sb	string buffer.
[in]	str	string to append.
[in]	len	string length.

Returns

nmsg_res_success

nmsg_res_memfail

nmsg_strbuf_append_str()

nmsg_res nmsg_strbuf_append_str	(	struct nmsg_strbuf *	sb,
		const char *	str,
		size_t	len
	)

Append to a string buffer.

Parameters

[in]	sb	string buffer.
[in]	str	string to append.
[in]	len	string length.

Returns

nmsg_res_success

nmsg_res_memfail

nmsg_strbuf_append()

nmsg_res nmsg_strbuf_append	(	struct nmsg_strbuf *	sb,
		const char *	fmt,
			...
	)

Append formatted string to a string buffer.

Parameters

[in]	sb	string buffer.
[in]	fmt	format string to be passed to vsnprintf.
[in]	...	arguments to vsnprintf.

Returns

nmsg_res_success

nmsg_res_memfail

nmsg_res_failure

nmsg_strbuf_reset()

nmsg_res nmsg_strbuf_reset

(

struct nmsg_strbuf *

sb

)

Reset a string buffer.

Resets the size of the internal buffer to the default size, but does not clear the contents of the buffer.

Parameters

[in]

sb

string buffer.

Returns

nmsg_res_success

nmsg_strbuf_len()

size_t nmsg_strbuf_len

(

struct nmsg_strbuf *

sb

)

Find the length of the used portion of the string buffer.

Parameters

[in]

sb

string buffer.

Returns

Number of bytes consumed by the string.