Function tskit::bindings::tsk_treeseq_loadf
source · pub unsafe extern "C" fn tsk_treeseq_loadf(
self_: *mut tsk_treeseq_t,
file: *mut FILE,
options: tsk_flags_t
) -> c_int
Expand description
@brief Load a tree sequence from a stream.
@rst
Loads a tree sequence from the specified file stream. 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_loadf
please
see that function’s documentation for details and options.
@endrst
@param self A pointer to an uninitialised tsk_treeseq_t object. @param file A FILE stream opened in an appropriate mode for reading (e.g. “r”, “r+” or “w+”) positioned at the beginning of a tree sequence definition. @param options Bitwise options. See above for details. @return Return 0 on success or a negative value on failure.