Struct ion_c_sys::_ion_collection

#[repr(C)]
pub struct _ion_collection {
    pub _owner: *mut c_void,
    pub _node_size: i32,
    pub _count: i32,
    pub _head: *mut ION_COLLECTION_NODE,
    pub _tail: *mut ION_COLLECTION_NODE,
    pub _freelist: *mut ION_COLLECTION_NODE,
}

The collections used by the parser are linked lists which are managed by the collection header. the memory used for the nodes is allocated on the parent, which is passed in when the user initializes the collection

the nodes in the list have a user sized data buffer, which is expected to a small struct (like ion string) or a scaler (like an int or pointer).

the push, pop, and append routines return the address of this data buffer - for push and append it is the buffer of the new node for pop it is the buffer of the released node - which is still allocated and is, therefore, good UNTIL ANOTHER push or append or copy is executed against the containing collection.

each collections holds a high water mark free list of nodes that were previously used but aren’t currently being used

to use this as a: queue you’ll want to “append” and “pop head” stack you’ll want to “push” and “pop head”

Fields

_owner: *mut c_void

_node_size: i32

_count: i32

_head: *mut ION_COLLECTION_NODE

_tail: *mut ION_COLLECTION_NODE

_freelist: *mut ION_COLLECTION_NODE

Trait Implementations

impl Clone for _ion_collection

fn clone(&self) -> _ion_collection

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for _ion_collection

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for _ion_collection

fn default() -> Self

Returns the “default value” for a type.

impl Copy for _ion_collection