Trait tskit::ffi::TskitType

pub trait TskitType<T> {
    fn wrap() -> Self;
    fn as_ptr(&self) -> *const T;
    fn as_mut_ptr(&mut self) -> *mut T;
}

Define what it means to wrap a tskit struct. In practice, one needs to implement Drop for test types, calling the tsk_foo_free() function corresponding to tsk_foo_t.

Required methods

fn wrap() -> Self

Encapsulate tsk_foo_t and return rust object. Best practices seem to suggest using Box for this.

fn as_ptr(&self) -> *const T

Return const pointer

fn as_mut_ptr(&mut self) -> *mut T

Return mutable pointer

Loading content...

Implementors

impl TskitType<tsk_table_collection_t> for TableCollection

fn wrap() -> Self

fn as_ptr(&self) -> *const tsk_table_collection_t

fn as_mut_ptr(&mut self) -> *mut tsk_table_collection_t

Loading content...