GskBuffer
a fast, flexible in-memory data buffer
This code manages a binary data buffer.
Data is maintained first-in first-out; so
gsk_buffer_append() writes to the end of the buffer,
and gsk_buffer_read() reads from the beginning.
A buffer is just a list of fragments and a size counter.
@size: the number of bytes in the buffer total.
@first_frag: the first fragment in the buffer (read end)
@last_frag: the last fragment in the buffer (write end)
This structure should rarely be accessed directly,
instead you should use the GskBuffer methods.
They are exposed for optimization and debugging convenience.
A single contiguous chunk of memory in the buffer.
Each #GskBufferFragment is managed by a single buffer,
but internally fragments are sometimes transferred whole between buffers.
A foreign fragment is one which created with
gsk_buffer_append_foreign(). It means that gsk
will use the destroy method rather than the normal
buffer pool, where data and the GskBufferFragment
are allocated continguously.
The headers of foreign fragments are pooled in a separate pool.
@next: next fragment in the buffer.
@buf: raw data in the buffer
@buf_max_size: maximum size of buffer, assuming buf_start==0.
@buf_start: offset in @buf of first readable data.
@buf_length: number of bytes currently in the buffer.
@is_foreign: is this fragment foreign?
@destroy: function to free foreign data.
@destroy_data: data to destroy to free buf, if foreign.
@buffer:
@buffer:
@data:
@max_length:
@Returns:
@buffer:
@data:
@max_length:
@Returns:
@buffer:
@max_discard:
@Returns:
@buffer:
@Returns:
@buffer:
@Returns:
@buffer:
@Returns:
@buffer:
@Returns:
@buffer:
@data:
@length:
@buffer:
@string:
@buffer:
@character:
@buffer:
@string:
@buffer:
@data:
@length:
@destroy:
@destroy_data:
@buffer:
@format:
@Varargs:
@buffer:
@format:
@args:
@dst:
@src:
@Returns:
@dst:
@src:
@max_transfer:
@Returns:
@read_from:
@fd:
@Returns:
@write_to:
@read_from:
@Returns:
@buffer:
@char_to_find:
@Returns:
@buffer:
@strings:
@Returns:
@to_destroy:
An iterator which can be used to walk through a buffer.
You MUST not modify the buffer that you are editing in any way.
TODO: exceptions to the above may be feasible,
but we have to see what the demands are...
@fragment: which fragment we are currently in.
@in_cur: the offset in bytes into @fragment.
@cur_length: the length of fragment.
@cur_data: the data of fragment.
@offset: the offset in bytes into the whole buffer.
Get the offset in bytes into #GskBuffer that we
are into the whole buffer.
@iterator: the iterator to examine.
@iterator:
@to_iterate:
@iterator:
@out:
@max_length:
@Returns:
@iterator:
@out:
@max_length:
@Returns:
@iterator:
@max_length:
@Returns:
@iterator:
@c:
@Returns:
Macro which can be used to initialize an empty buffer.
One can write:
GskBuffer buf = GSK_BUFFER_STATIC_INIT;