Struct tskit::provenance::OwningProvenanceTable

pub struct OwningProvenanceTable { /* private fields */ }

Available on crate feature provenance only.

A provenance table that owns its own data.

Examples

{
use tskit::provenance::OwningProvenanceTable;
let mut provenances = OwningProvenanceTable::default();
let id = provenances.add_row("message").unwrap();
assert_eq!(id, 0);
assert_eq!(provenances.num_rows(), 1);

Implementations

impl OwningProvenanceTable

pub fn clear(&mut self) -> TskReturnValue

Clear the table.

impl OwningProvenanceTable

pub fn as_ptr(&self) -> *const tsk_provenance_table_t

pub fn as_mut_ptr(&mut self) -> *mut tsk_provenance_table_t

impl OwningProvenanceTable

pub fn add_row(&mut self, record: &str) -> Result<ProvenanceId, TskitError>

Methods from Deref<Target = ProvenanceTable>

pub fn num_rows(&self) -> SizeType

Return the number of rows

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

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<&str>

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 row_view<P: Into<ProvenanceId> + Copy>( &self, row: P ) -> Option<ProvenanceTableRowView<'_>>

Obtain a ProvenanceTableRowView for row row.

Returns

• Some(row view) 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.

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

Trait Implementations

impl Default for OwningProvenanceTable

fn default() -> Self

Returns the “default value” for a type.

impl Deref for OwningProvenanceTable

type Target = ProvenanceTable

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for OwningProvenanceTable

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.