Struct tskit::provenance::ProvenanceTable
source · [−]pub struct ProvenanceTable<'a> { /* private fields */ }Expand description
An immutable view of a provenance table.
These are not created directly.
Instead, use crate::TableCollection::provenances
or crate::TreeSequence::provenances
to get a reference to an existing node table;
Notes
- The type is enabled by the
"provenance"feature.
Implementations
sourceimpl<'a> ProvenanceTable<'a>
impl<'a> ProvenanceTable<'a>
sourcepub fn timestamp<P: Into<ProvenanceId> + Copy>(
&'a self,
row: P
) -> Result<String, TskitError>
pub fn timestamp<P: Into<ProvenanceId> + Copy>(
&'a self,
row: P
) -> Result<String, TskitError>
sourcepub fn record<P: Into<ProvenanceId> + Copy>(
&'a self,
row: P
) -> Result<String, TskitError>
pub fn record<P: Into<ProvenanceId> + Copy>(
&'a self,
row: P
) -> Result<String, TskitError>
sourcepub fn row<P: Into<ProvenanceId> + Copy>(
&'a self,
row: P
) -> Result<ProvenanceTableRow, TskitError>
pub fn row<P: Into<ProvenanceId> + Copy>(
&'a self,
row: P
) -> Result<ProvenanceTableRow, TskitError>
sourcepub fn iter(&self) -> impl Iterator<Item = ProvenanceTableRow> + '_
pub fn iter(&self) -> impl Iterator<Item = ProvenanceTableRow> + '_
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more