Struct tskit::MigrationTable
source · pub struct MigrationTable { /* private fields */ }
Expand description
An immutable view of a migration table.
These are not created directly but are accessed
by types implementing std::ops::Deref
to
crate::table_views::TableViews
Implementations
sourceimpl MigrationTable
impl MigrationTable
sourcepub fn right<M: Into<MigrationId> + Copy>(&self, row: M) -> Option<Position>
pub fn right<M: Into<MigrationId> + Copy>(&self, row: M) -> Option<Position>
Return the right coordinate for a given row.
Returns
Some(positions)
ifrow
is valid.None
otherwise.
sourcepub fn source<M: Into<MigrationId> + Copy>(&self, row: M) -> Option<PopulationId>
pub fn source<M: Into<MigrationId> + Copy>(&self, row: M) -> Option<PopulationId>
Return the source population for a given row.
Returns
Some(population)
ifrow
is valid.None
otherwise.
sourcepub fn dest<M: Into<MigrationId> + Copy>(&self, row: M) -> Option<PopulationId>
pub fn dest<M: Into<MigrationId> + Copy>(&self, row: M) -> Option<PopulationId>
Return the destination population for a given row.
Returns
Some(population)
ifrow
is valid.None
otherwise.
sourcepub fn time<M: Into<MigrationId> + Copy>(&self, row: M) -> Option<Time>
pub fn time<M: Into<MigrationId> + Copy>(&self, row: M) -> Option<Time>
Return the time of the migration event for a given row.
Returns
Some(time)
ifrow
is valid.None
otherwise.
sourcepub fn metadata<T: MigrationMetadata>(
&self,
row: MigrationId
) -> Option<Result<T, TskitError>>
pub fn metadata<T: MigrationMetadata>(
&self,
row: MigrationId
) -> Option<Result<T, TskitError>>
Retrieve decoded metadata for a row
.
Returns
Some(Ok(T))
ifrow
is valid and decoding succeeded.Some(Err(_))
ifrow
is not valid and decoding failed.None
ifrow
is not valid.
Errors
TskitError::MetadataError
if decoding fails.
Examples.
The big-picture semantics are the same for all table types.
See crate::IndividualTable::metadata
for examples.
sourcepub fn iter(&self) -> impl Iterator<Item = MigrationTableRow> + '_
pub fn iter(&self) -> impl Iterator<Item = MigrationTableRow> + '_
Return an iterator over rows of the table.
The value of the iterator is MigrationTableRow
.
sourcepub fn row<M: Into<MigrationId> + Copy>(&self, r: M) -> Option<MigrationTableRow>
pub fn row<M: Into<MigrationId> + Copy>(&self, r: M) -> Option<MigrationTableRow>
Auto Trait Implementations
impl RefUnwindSafe for MigrationTable
impl !Send for MigrationTable
impl !Sync for MigrationTable
impl Unpin for MigrationTable
impl UnwindSafe for MigrationTable
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
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