Struct tskit::SiteTable[][src]

pub struct SiteTable<'a> { /* fields omitted */ }

An immutable view of site table.

These are not created directly. Instead, use TableCollection::sites to get a reference to an existing site table;

Implementations

impl<'a> SiteTable<'a>[src]

pub fn num_rows(&'a self) -> tsk_size_t[src]

Return the number of rows

pub fn position(&'a self, row: tsk_id_t) -> Result<f64, TskitError>[src]

Return the position value from row row of the table.

Errors

Will return IndexError if row is out of range.

pub fn ancestral_state(
    &'a self,
    row: tsk_id_t
) -> Result<Option<Vec<u8>>, TskitError>
[src]

Get the ancestral_state value from row row of the table.

Return

Will return None if there is no ancestral state.

Errors

Will return IndexError if row is out of range.

pub fn metadata<T: MetadataRoundtrip>(
    &'a self,
    row: tsk_id_t
) -> Result<Option<T>, TskitError>
[src]

Auto Trait Implementations

impl<'a> RefUnwindSafe for SiteTable<'a>

impl<'a> !Send for SiteTable<'a>

impl<'a> !Sync for SiteTable<'a>

impl<'a> Unpin for SiteTable<'a>

impl<'a> UnwindSafe for SiteTable<'a>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.