Struct tskit::provenance::ProvenanceTable

pub struct ProvenanceTable<'a> { /* fields omitted */ }

An immutable view of a provenance table.

These are not created directly. Instead, use Provenance::provenances to get a reference to an existing node table;

Notes

• The type is enabled by the "provenance" feature.

Implementations

impl<'a> ProvenanceTable<'a>

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

Return the number of rows

pub fn timestamp<P: Into<ProvenanceId> + Copy>(
    &'a self,
    row: P
) -> Result<String, TskitError>

Get the ISO-formatted time stamp for row row.

Errors

TskitError::IndexError if r is out of range.

pub fn record<P: Into<ProvenanceId> + Copy>(
    &'a self,
    row: P
) -> Result<String, TskitError>

Get the provenance record for row row.

Errors

TskitError::IndexError if r is out of range.

pub fn row<P: Into<ProvenanceId> + Copy>(
    &'a self,
    row: P
) -> Result<ProvenanceTableRow, TskitError>

Obtain a ProvenanceTableRow for row row.

Errors

TskitError::IndexError if r is out of range.

pub fn iter(&self) -> TableIterator<&'_ ProvenanceTable<'_>>

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