Skip to main content

hurray_item_node

Function hurray_item_node 

Source
#[unsafe(no_mangle)]
pub unsafe extern "C" fn hurray_item_node( handle: *const HurrayItem, index: u64, out_node: *mut HurrayItemNode, ) -> HurrayStatus
Expand description

Copies node index into out_node.

Nodes are in preorder: node 0 is the root, and a node’s member_count direct members begin at the next index, each followed immediately by its own subtree. The pointers inside the node borrow from the item and are valid until hurray_item_destroy.

Returns HURRAY_ERR_INDEX_OUT_OF_BOUNDS if index is past the end.

§Safety

handle MUST point to a live HurrayItem, and out_node MUST be a valid, non-null pointer writable for one HurrayItemNode.