Function tskit::bindings::tsk_table_collection_dumpf

pub unsafe extern "C" fn tsk_table_collection_dumpf(
    self_: *const 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.

@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. 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.