Struct tskit::MutationTable [−][src]
pub struct MutationTable<'a> { /* fields omitted */ }
Expand description
An immutable view of site table.
These are not created directly.
Instead, use TableCollection::mutations
to get a reference to an existing mutation table;
Implementations
Return the number of rows.
Return the site
value from row row
of the table.
Errors
Will return IndexError
if row
is out of range.
Return the node
value from row row
of the table.
Errors
Will return IndexError
if row
is out of range.
Return the parent
value from row row
of the table.
Errors
Will return IndexError
if row
is out of range.
Return the time
value from row row
of the table.
Errors
Will return IndexError
if row
is out of range.
pub fn derived_state<M: Into<MutationId>>(
&'a self,
row: M
) -> Result<Option<Vec<u8>>, TskitError>
pub fn derived_state<M: Into<MutationId>>(
&'a self,
row: M
) -> Result<Option<Vec<u8>>, TskitError>
Get the derived_state
value from row row
of the table.
Return
Will return None
if there is no derived state.
Errors
Will return IndexError
if row
is out of range.
pub fn metadata<T: MetadataRoundtrip>(
&'a self,
row: MutationId
) -> Result<Option<T>, TskitError>
Return an iterator over rows of the table.
The value of the iterator is MutationTableRow
.
Return row r
of the table.
Parameters
r
: the row id.
Errors
TskitError::IndexError
if r
is out of range.