Function tskit::bindings::tsk_table_collection_dumpf

pub unsafe extern "C" fn tsk_table_collection_dumpf(
    self_: *mut tsk_table_collection_t, 
    file: *mut FILE, 
    options: tsk_flags_t
) -> c_int

@brief Write a table collection to a stream.

@rst Writes the data from this table collection to the specified FILE stream. Semantics are identical to :c:func:tsk_table_collection_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.

Options**

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

TSK_NO_BUILD_INDEXES Do not build indexes for this table before writing to file. This is useful if you wish to write unsorted tables to file, as building the indexes will raise an error if the table is unsorted.

@endrst

@param self A pointer to an initialised tsk_table_collection_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. See above for details. @return Return 0 on success or a negative value on failure.