Struct tskit::provenance::ProvenanceTable

pub struct ProvenanceTable { /* private fields */ }

Available on crate feature provenance only.

An immutable view of a provenance table.

These are not created directly. to get a reference to an existing provenance table;

Notes

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

Implementations

impl ProvenanceTable

pub fn num_rows(&self) -> SizeType

Return the number of rows

pub fn timestamp<P: Into<ProvenanceId> + Copy>(&self, row: P) -> Option<String>

Get the ISO-formatted time stamp for row row.

Returns

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

Examples

let mut tables = tskit::TableCollection::new(10.).unwrap();
assert!(tables.add_provenance("foo").is_ok());
if let Some(timestamp) = tables.provenances().timestamp(0) {
 // then 0 is a valid row in the provenance table
}

pub fn record<P: Into<ProvenanceId> + Copy>(&self, row: P) -> Option<String>

Get the provenance record for row row.

Returns

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

Examples

let mut tables = tskit::TableCollection::new(10.).unwrap();
assert!(tables.add_provenance("foo").is_ok());
if let Some(record) = tables.provenances().record(0) {
 // then 0 is a valid row in the provenance table
}

pub fn row<P: Into<ProvenanceId> + Copy>(
    &self,
    row: P
) -> Option<ProvenanceTableRow>

Obtain a ProvenanceTableRow for row row.

Returns

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

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

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