Struct tskit::SiteTable

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

An immutable view of site table.

Implementations

impl SiteTable

pub fn num_rows(&self) -> SizeType

Return the number of rows

pub fn position<S: Into<SiteId> + Copy>(&self, row: S) -> Option<Position>

Return the position value from row row of the table.

Returns

• Some(position) if row is valid.
• None otherwise.

pub fn ancestral_state<S: Into<SiteId>>(&self, row: S) -> Option<&[u8]>

Get the ancestral_state value from row row of the table.

Returns

• Some(ancestral state) if row is valid.
• None otherwise.

pub fn metadata<T: SiteMetadata>( &self, row: SiteId ) -> 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 = SiteTableRow> + '_

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

pub fn lending_iter(&self) -> SiteTableRowView<'_>

pub fn row<S: Into<SiteId> + Copy>(&self, r: S) -> Option<SiteTableRow>

Return row r of the table.

Parameters

• r: the row id.

Returns

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

pub fn row_view<S: Into<SiteId> + Copy>( &self, r: S ) -> Option<SiteTableRowView<'_>>

Return a view of row r of the table.

Parameters

• r: the row id.

Returns

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

pub fn position_slice(&self) -> &[Position]

Get the position column as a slice

pub fn position_slice_raw(&self) -> &[f64]

Get the position column as a slice

Trait Implementations

impl Debug for SiteTable

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.