Function tskit::bindings::tsk_treeseq_load

pub unsafe extern "C" fn tsk_treeseq_load(
    self_: *mut tsk_treeseq_t,
    filename: *const c_char,
    options: tsk_flags_t
) -> c_int

@brief Load a tree sequence from a file path.

@rst Loads the data from the specified file into this tree sequence. The tree sequence is also initialised. The resources allocated must be freed using :c:func:tsk_treeseq_free even in error conditions.

Works similarly to :c:func:tsk_table_collection_load please see that function’s documentation for details and options.

Examples**

.. code-block:: c

int ret; tsk_treeseq_t ts; ret = tsk_treeseq_load(&ts, “data.trees”, 0); if (ret != 0) { fprintf(stderr, “Load error:%s\n”, tsk_strerror(ret)); exit(EXIT_FAILURE); }

@endrst

@param self A pointer to an uninitialised tsk_treeseq_t object @param filename A NULL terminated string containing the filename. @param options Bitwise options. See above for details. @return Return 0 on success or a negative value on failure.