Function tskit::bindings::tsk_edge_table_init[][src]

pub unsafe extern "C" fn tsk_edge_table_init(
    self_: *mut tsk_edge_table_t,
    options: tsk_flags_t
) -> c_int

@brief Initialises the table by allocating the internal memory.

@rst This must be called before any operations are performed on the table. See the :ref:sec_c_api_overview_structure for details on how objects are initialised and freed.

Options**

Options can be specified by providing one or more of the following bitwise flags:

TSK_NO_METADATA Do not allocate space to store metadata in this table. Operations attempting to add non-empty metadata to the table will fail with error TSK_ERR_METADATA_DISABLED.

@endrst

@param self A pointer to an uninitialised tsk_edge_table_t object. @param options Allocation time options. @return Return 0 on success or a negative value on failure.