This group discusses the functions that provide string buffers management.

The Binary Buffer data type is designed to be a mutable string, allowing to append, prepend, or insert a string into a buffer.

Functions
Eina_Binbuf *	eina_binbuf_new (void)
	Creates a new string buffer.
Eina_Binbuf *	eina_binbuf_manage_new_length (unsigned char *str, size_t length)
	Creates a new string buffer using the passed string. The passed string is used directly as the buffer, it's somehow the opposite function of eina_binbuf_string_steal . The passed string must be malloced.
void	eina_binbuf_free (Eina_Binbuf *buf)
	Frees a string buffer.
void	eina_binbuf_reset (Eina_Binbuf *buf)
	Resets a string buffer.
Eina_Bool	eina_binbuf_append_length (Eina_Binbuf buf, const unsigned char str, size_t length)
	Appends a string of exact length to a buffer, reallocating as necessary.
Eina_Bool	eina_binbuf_append_char (Eina_Binbuf *buf, unsigned char c)
	Appends a character to a string buffer, reallocating as necessary.
Eina_Bool	eina_binbuf_insert_length (Eina_Binbuf buf, const unsigned char str, size_t length, size_t pos)
	Inserts a string of exact length into a buffer, reallocating as necessary.
Eina_Bool	eina_binbuf_insert_char (Eina_Binbuf *buf, unsigned char c, size_t pos)
	Inserts a character into a string buffer, reallocating as necessary.
Eina_Bool	eina_binbuf_remove (Eina_Binbuf *buf, size_t start, size_t end)
	Removes a slice of the given string buffer.
const unsigned char *	eina_binbuf_string_get (const Eina_Binbuf *buf)
	Gets a pointer to the contents of a string buffer.
unsigned char *	eina_binbuf_string_steal (Eina_Binbuf *buf)
	Steals the contents of a string buffer.
void	eina_binbuf_string_free (Eina_Binbuf *buf)
	Frees the contents of a string buffer but not the buffer.
size_t	eina_binbuf_length_get (const Eina_Binbuf *buf)
	Gets the length of the string buffer's content.
Typedefs
typedef struct _Eina_Strbuf	Eina_Binbuf
	The structure type for a string buffer.

Function Documentation

Eina_Bool eina_binbuf_append_char	(	Eina_Binbuf *	buf,
		unsigned char	c
	)

Appends a character to a string buffer, reallocating as necessary.

This function inserts c to buf. If it cannot insert it, EINA_FALSE is returned, otherwise EINA_TRUE is returned.

Since :: 2.3.1

Parameters:

[in]	buf	The string buffer to append to
[in]	c	The character to append

Returns:: EINA_TRUE on success, otherwise EINA_FALSE on failure

Eina_Bool eina_binbuf_append_length	(	Eina_Binbuf *	buf,
		const unsigned char *	str,
		size_t	length
	)

Appends a string of exact length to a buffer, reallocating as necessary.

This function appends str to buf. str must be at most of size length. It is slightly faster than eina_binbuf_append() as it does not compute the size of str. It is useful when dealing with strings of known size, such as eina_strngshare. If buf can't append it, EINA_FALSE is returned, otherwise EINA_TRUE is returned.

Since :: 2.3.1

Parameters:

[in]	buf	The string buffer to append to
[in]	str	The string to append
[in]	length	The exact length to use

Returns:: EINA_TRUE on success, otherwise EINA_FALSE on failure

See also:: eina_stringshare_length(); eina_binbuf_append(); eina_binbuf_append_n()

void eina_binbuf_free ( Eina_Binbuf * buf )

Frees a string buffer.

This function frees the memory of buf. buf must have been created by eina_binbuf_new().

Since :: 2.3.1

Parameters:

[in] buf The string buffer to free

Eina_Bool eina_binbuf_insert_char	(	Eina_Binbuf *	buf,
		unsigned char	c,
		size_t	pos
	)

Inserts a character into a string buffer, reallocating as necessary.

This function inserts c into buf at position pos. If buf can't append it, EINA_FALSE is returned, otherwise EINA_TRUE is returned.

Since :: 2.3.1

Parameters:

[in]	buf	The string buffer to insert into
[in]	c	The character to insert
[in]	pos	The position at which to insert the character

Returns:: EINA_TRUE on success, otherwise EINA_FALSE on failure

Eina_Bool eina_binbuf_insert_length	(	Eina_Binbuf *	buf,
		const unsigned char *	str,
		size_t	length,
		size_t	pos
	)

Inserts a string of exact length into a buffer, reallocating as necessary.

This function inserts str into buf. str must be at most of size length. It is slightly faster than eina_binbuf_insert() as it does not compute the size of str. It is useful when dealing with strings of known size, such as eina_strngshare. If buf can't insert it, EINA_FALSE is returned, otherwise EINA_TRUE is returned.

Since :: 2.3.1

Parameters:

[in]	buf	The string buffer to insert to
[in]	str	The string to insert
[in]	length	The exact length to use
[in]	pos	The position at which to insert the string

Returns:: EINA_TRUE on success, otherwise EINA_FALSE on failure

See also:: eina_stringshare_length(); eina_binbuf_insert(); eina_binbuf_insert_n()

size_t eina_binbuf_length_get ( const Eina_Binbuf * buf )

Gets the length of the string buffer's content.

This function returns the length of buf.

Since :: 2.3.1

Parameters:

[in] buf The string buffer

Returns:: The current length of the string, in bytes

Eina_Binbuf* eina_binbuf_manage_new_length	(	unsigned char *	str,
		size_t	length
	)

Creates a new string buffer using the passed string. The passed string is used directly as the buffer, it's somehow the opposite function of eina_binbuf_string_steal . The passed string must be malloced.

This function creates a new string buffer. On error, NULL is returned and Eina error is set to EINA_ERROR_OUT_OF_MEMORY. To free the resources, use eina_binbuf_free().

Since (EFL) :: 1.2.0

Since :: 2.3.1

Parameters:

[in]	str	The string to manage
[in]	length	The length of the string

Returns:: A newly allocated string buffer instance

See also:: eina_binbuf_manage_new()

Eina_Binbuf* eina_binbuf_new ( void )

Creates a new string buffer.

This function creates a new string buffer. On error, NULL is returned and Eina error is set to EINA_ERROR_OUT_OF_MEMORY. To free the resources, use eina_binbuf_free().

Since :: 2.3.1

Returns:: Newly allocated string buffer instance.

See also:: eina_binbuf_free(); eina_binbuf_append(); eina_binbuf_string_get()

Eina_Bool eina_binbuf_remove	(	Eina_Binbuf *	buf,
		size_t	start,
		size_t	end
	)

Removes a slice of the given string buffer.

This function removes a slice of buf, starting from start (inclusive) and ending at end (non-inclusive). Both values are in bytes. It returns EINA_FALSE on failure, otherwise EINA_TRUE.

Since :: 2.3.1

Parameters:

[in]	buf	The string buffer to remove a slice of
[in]	start	The initial (inclusive) slice position to start removing from, in bytes
[in]	end	The final (non-inclusive) slice position to finish removing at, in bytes

Returns:: EINA_TRUE on success, otherwise EINA_FALSE on failure

void eina_binbuf_reset ( Eina_Binbuf * buf )

Resets a string buffer.

This function resets buf, the buffer length is set to 0 and the string is set to '\0'. No memory is freed.

Since :: 2.3.1

Parameters:

[in] buf The string buffer to reset

void eina_binbuf_string_free ( Eina_Binbuf * buf )

Frees the contents of a string buffer but not the buffer.

This function frees the string contained in buf without freeing buf.

Since :: 2.3.1

Parameters:

[in] buf The string buffer to free the string of

const unsigned char* eina_binbuf_string_get ( const Eina_Binbuf * buf )

Gets a pointer to the contents of a string buffer.

This function returns the string contained in buf. The returned value must not be modified and is no longer valid if buf is modified. In other words, any eina_binbuf_append() or similar makes that pointer invalid.

Since :: 2.3.1

Parameters:

[in] buf The string buffer

Returns:: The current string in the string buffer

See also:: eina_binbuf_string_steal()

unsigned char* eina_binbuf_string_steal ( Eina_Binbuf * buf )

Steals the contents of a string buffer.

This function returns the string contained in buf. buf is then initialized and does not own the returned string anymore. The caller must release the memory of the returned string by calling free().

Since :: 2.3.1

Parameters:

[in] buf The string buffer to steal from

Returns:: The current string in the string buffer

See also:: eina_binbuf_string_get()

Functions

Typedefs

Function Documentation