Struct tskit::PopulationTable

#[repr(transparent)]
pub struct PopulationTable { /* private fields */ }

An immutable view of site table.

These are not created directly but are accessed by types implementing std::ops::Deref to crate::table_views::TableViews

Implementations

impl PopulationTable

pub fn num_rows(&self) -> SizeType

Return the number of rows.

pub fn metadata<T: PopulationMetadata>(
    &self,
    row: PopulationId
) -> Option<Result<T, TskitError>>

Retrieve decoded metadata for a row.

Returns

• Some(Ok(T)) if row is valid and decoding succeeded.
• Some(Err(_)) if row is not valid and decoding failed.
• None if row is not valid.

Errors

• TskitError::MetadataError if decoding fails.

Examples.

The big-picture semantics are the same for all table types. See crate::IndividualTable::metadata for examples.

pub fn iter(&self) -> impl Iterator<Item = PopulationTableRow> + '_

Return an iterator over rows of the table. The value of the iterator is PopulationTableRow.

pub fn row<P: Into<PopulationId> + Copy>(
    &self,
    r: P
) -> Option<PopulationTableRow>

Return row r of the table.

Parameters

• r: the row id.

Returns

• Some(row) if r is valid
• None otherwise