Function tskit::bindings::tsk_treeseq_dumpf
source · pub unsafe extern "C" fn tsk_treeseq_dumpf(
self_: *const tsk_treeseq_t,
file: *mut FILE,
options: tsk_flags_t
) -> c_int
Expand description
@brief Write a tree sequence to a stream.
@rst
Writes the data from this tree sequence to the specified FILE stream.
Semantics are identical to :c:func:tsk_treeseq_dump
.
Please see the :ref:sec_c_api_examples_file_streaming
section for an example
of how to sequentially dump and load tree sequences from a stream.
@endrst
@param self A pointer to an initialised tsk_treeseq_t object. @param file A FILE stream opened in an appropriate mode for writing (e.g. “w”, “a”, “r+” or “w+”). @param options Bitwise options. Currently unused; should be set to zero to ensure compatibility with later versions of tskit. @return Return 0 on success or a negative value on failure.