BufferListIterator

---

Object Hierarchy:

Description:

Content:

Methods:

• public void add (owned Buffer buffer)
  Inserts buffer into the BufferList iterated with it. The buffer is inserted into the current group, immediately before the buffer that would be returned by next. The buffer is inserted before the implicit cursor, a subsequent call to next will return the buffer after the inserted buffer, if any. This function takes ownership of buffer.
• public void add_group ()
  Inserts a new, empty group into the BufferList iterated with it. The group is inserted immediately before the group that would be returned by next_group. A subsequent call to next_group will advance the iterator to the group after the inserted group, if any.
• public void add_list (List list)
  Inserts list of buffers into the BufferList iterated with it. The list is inserted into the current group, immediately before the buffer that would be returned by next. The list is inserted before the implicit cursor, a subsequent call to next will return the buffer after the last buffer of the inserted list, if any. This function takes ownership of list and all its buffers.
• public weak Buffer? do (BufferListDoFunction do_func)
  Calls the given function for the last buffer returned by next. next must have been called on it before this function is called. remove and steal must not have been called since the last call to next. See BufferListDoFunction for more details.
• public Buffer? merge_group ()
  Merge a buffer list group into a normal Buffer by copying its metadata and memcpying its data into consecutive memory. All buffers in the current group after the implicit cursor will be merged into one new buffer. The metadata of the new buffer will be a copy of the metadata of the buffer that would be returned by next. If there is no buffer in the current group after the implicit cursor, NULL will be returned. This function will not move the implicit cursor or in any other way affect the state of the iterator it or the list. or NULL
• public uint n_buffers ()
  Returns the number of buffers left to iterate in the current group. I.e. the number of calls that can be made to next before it returns NULL. This function will not move the implicit cursor or in any other way affect the state of the iterator it.
• public weak Buffer? next ()
  Returns the next buffer in the list iterated with it. If the iterator is at the end of a group, NULL will be returned. This function may be called repeatedly to iterate through the current group. The caller will not get a new ref to the returned Buffer and must not unref it. buffer list, or NULL
• public bool next_group ()
  Advance the iterator it to the first buffer in the next group. If the iterator is at the last group, FALSE will be returned. This function may be called repeatedly to iterate through the groups in a buffer list. the iterator was already at the last group
• public void remove ()
  Removes the last buffer returned by next from the BufferList iterated with it. next must have been called on it before this function is called. This function can only be called once per call to next. The removed buffer is unreffed.
• public weak Buffer? steal ()
  Returns the last buffer returned by next without modifying the refcount of the buffer. next
• public void take (owned Buffer buffer)
  Replaces the last buffer returned by next with this function is called. remove must not have been called since the last call to next. This function unrefs the replaced buffer if it has not been stolen with steal and takes ownership of buffer (i.e. the refcount of buffer is not increased).