gate_stringstream_t Interface Reference

A stream to operate on a gate_strbuilder_t and can be exported as a gate_string_t. More...

#include <streams.h>

Inheritance diagram for gate_stringstream_t:

Public Member Functions
char const *	get_data ()
	Returns a pointer to the begin of the readable memory block.
gate_size_t	size ()
	Returns the current size of accessible data.
gate_result_t	get_current_view (gate_string_t *ptr_output)
	Exports a view of the current data in the memory stream.
gate_result_t	to_string (gate_string_t *ptr_output)
	Creates a gate_string_t object from the internal content.
Public Member Functions inherited from gate_stream_t
gate_result_t	read (char *buffer, gate_size_t bufferlength, gate_size_t *returned)
	Read bytes from stream and stores them in the given buffer.
gate_result_t	peek (char *buffer, gate_size_t bufferlength, gate_size_t *returned)
	Tries to read bytes from the stream, but leaves them in its input buffer to be read again.
gate_result_t	write (char const *buffer, gate_size_t bufferlength, gate_size_t *written)
	Writes bytes from the given buffer into the stream.
gate_result_t	flush ()
	Instructs the stream to flush its internal buffers and make current status persistent.
Public Member Functions inherited from gate_object_t
char const *	get_interface_name ()
	Returns on object's interface path name.
void	release ()
	Decrease object's reference counter, releases the object when count reaches zero.
int	retain ()
	Increase object's reference counter.

Detailed Description

A stream to operate on a gate_strbuilder_t and can be exported as a gate_string_t.

Member Function Documentation

get_data()

char const * get_data

(

)

Returns a pointer to the begin of the readable memory block.

Returns

Pointer to current data in internal buffer

size()

gate_size_t size

(

)

Returns the current size of accessible data.

Returns

Amount of current bytes in buffer

get_current_view()

gate_result_t get_current_view

(

gate_string_t *

ptr_output

)

Exports a view of the current data in the memory stream.

Parameters

[in]

ptr_output

Pointer to string to be initialized with current view of contained string

Returns

GATE_RESULT_* result code

to_string()

gate_result_t to_string

(

gate_string_t *

ptr_output

)

Creates a gate_string_t object from the internal content.

Parameters

[in]

ptr_output

Pointer to string to be initialized with content of string-stream

Returns

GATE_RESULT_* result code

---

The documentation for this interface was generated from the following file:

• streams.h