Struct tskit::IndividualTable [−][src]
pub struct IndividualTable<'a> { /* fields omitted */ }
Expand description
An immutable view of a individual table.
These are not created directly.
Instead, use TableCollection::individuals
to get a reference to an existing node table;
Implementations
impl<'a> IndividualTable<'a>
[src]
impl<'a> IndividualTable<'a>
[src]pub fn num_rows(&'a self) -> tsk_size_t
[src]
pub fn num_rows(&'a self) -> tsk_size_t
[src]Return the number of rows
pub fn flags(&self, row: tsk_id_t) -> Result<tsk_flags_t, TskitError>
[src]
pub fn flags(&self, row: tsk_id_t) -> Result<tsk_flags_t, TskitError>
[src]pub fn metadata<T: MetadataRoundtrip>(
&'a self,
row: tsk_id_t
) -> Result<Option<T>, TskitError>
[src]
pub fn metadata<T: MetadataRoundtrip>(
&'a self,
row: tsk_id_t
) -> Result<Option<T>, TskitError>
[src]pub fn iter(&self) -> TableIterator<&'_ IndividualTable<'_>>
[src]
pub fn iter(&self) -> TableIterator<&'_ IndividualTable<'_>>
[src]Return an iterator over rows of the table.
The value of the iterator is IndividualTableRow
.
pub fn row(&self, r: tsk_id_t) -> Result<IndividualTableRow, TskitError>
[src]
pub fn row(&self, r: tsk_id_t) -> Result<IndividualTableRow, TskitError>
[src]Return row r
of the table.
Parameters
r
: the row id.
Errors
TskitError::IndexError
if r
is out of range.