Crate tskit[][src]

A rust interface to tskit.

Re-exports

pub use bindings::TSK_NODE_IS_SAMPLE;
pub use bindings::TSK_NO_BUILD_INDEXES;
pub use bindings::TSK_SAMPLE_LISTS;
pub use bindings::tsk_flags_t;
pub use bindings::tsk_id_t;
pub use bindings::tsk_size_t;
pub use error::TskitError;

Modules

bindings

Low-level (“unsafe”) bindings to the C API.

error

Error handling

ffi

Define traits related to wrapping tskit stuff

metadata
types

“Other” tskit types live here.

Structs

EdgeTable

An immutable view of an edge table.

MutationTable

An immutable view of site table.

NodeTable

An immtable view of a node table.

PopulationTable

An immutable view of site table.

SiteTable

An immutable view of site table.

TableCollection

A table collection.

Tree

A Tree.

TreeFlags

Specify the behavior of iterating over Tree objects. See TreeSequence::tree_iterator.

TreeSequence

A tree sequence.

Enums

NodeTraversalOrder

Specify the traversal order used by Tree::nodes.

Constants

TSK_NULL

“Null” identifier value.

Traits

NodeIterator

Trait defining iteration over nodes.

Functions

version

Get the tskit version number.

Type Definitions

TskReturnValue

Handles return codes from low-level tskit functions.