Struct tskit::EdgeTable

#[repr(transparent)]
pub struct EdgeTable<'a> { /* private fields */ }

An immutable view of an edge table.

These are not created directly. Instead, use TableAccess::edges to get a reference to an existing edge table;

Implementations

impl<'a> EdgeTable<'a>

pub fn num_rows(&'a self) -> SizeType

Return the number of rows

pub fn parent<E: Into<EdgeId> + Copy>(
    &'a self,
    row: E
) -> Result<NodeId, TskitError>

Return the parent value from row row of the table.

Errors

Will return IndexError if row is out of range.

pub fn child<E: Into<EdgeId> + Copy>(
    &'a self,
    row: E
) -> Result<NodeId, TskitError>

Return the child value from row row of the table.

Errors

Will return IndexError if row is out of range.

pub fn left<E: Into<EdgeId> + Copy>(
    &'a self,
    row: E
) -> Result<Position, TskitError>

Return the left value from row row of the table.

Errors

Will return IndexError if row is out of range.

pub fn right<E: Into<EdgeId> + Copy>(
    &'a self,
    row: E
) -> Result<Position, TskitError>

Return the right value from row row of the table.

Errors

Will return IndexError if row is out of range.

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

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

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

pub fn row<E: Into<EdgeId> + Copy>(
    &self,
    r: E
) -> Result<EdgeTableRow, TskitError>

Return row r of the table.

Parameters

• r: the row id.

Errors

TskitError::IndexError if r is out of range.