Struct tskit::provenance::ProvenanceTable[−][src]

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>[src]

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

Return the number of rows

pub fn timestamp(&'a self, row: tsk_id_t) -> Result<String, TskitError>[src]

Get the ISO-formatted time stamp for row row.

Errors

TskitError::IndexError if r is out of range.

pub fn record(&'a self, row: tsk_id_t) -> Result<String, TskitError>[src]

Get the provenance record for row row.

Errors

TskitError::IndexError if r is out of range.

pub fn row(&'a self, row: tsk_id_t) -> Result<ProvenanceTableRow, TskitError>[src]

Obtain a ProvenanceTableRow for row row.

Errors

TskitError::IndexError if r is out of range.

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

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

Auto Trait Implementations

impl<'a> RefUnwindSafe for ProvenanceTable<'a>

impl<'a> !Send for ProvenanceTable<'a>

impl<'a> !Sync for ProvenanceTable<'a>

impl<'a> Unpin for ProvenanceTable<'a>

impl<'a> UnwindSafe for ProvenanceTable<'a>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.