pub struct EdgeTable<'a> { /* private fields */ }
Expand description
An immutable view of an edge table.
These are not created directly.
Instead, use TableCollection::edges
to get a reference to an existing edge table;
Implementations§
Source§impl<'a> EdgeTable<'a>
impl<'a> EdgeTable<'a>
Sourcepub fn num_rows(&'a self) -> tsk_size_t
pub fn num_rows(&'a self) -> tsk_size_t
Return the number of rows
Sourcepub fn parent(&'a self, row: tsk_id_t) -> Result<tsk_id_t, TskitRustError>
pub fn parent(&'a self, row: tsk_id_t) -> Result<tsk_id_t, TskitRustError>
Return the parent
value from row row
of the table.
§Errors
Will return IndexError
if row
is out of range.
Sourcepub fn child(&'a self, row: tsk_id_t) -> Result<tsk_id_t, TskitRustError>
pub fn child(&'a self, row: tsk_id_t) -> Result<tsk_id_t, TskitRustError>
Return the child
value from row row
of the table.
§Errors
Will return IndexError
if row
is out of range.
Sourcepub fn left(&'a self, row: tsk_id_t) -> Result<f64, TskitRustError>
pub fn left(&'a self, row: tsk_id_t) -> Result<f64, TskitRustError>
Return the left
value from row row
of the table.
§Errors
Will return IndexError
if row
is out of range.
Sourcepub fn right(&'a self, row: tsk_id_t) -> Result<f64, TskitRustError>
pub fn right(&'a self, row: tsk_id_t) -> Result<f64, TskitRustError>
Return the right
value from row row
of the table.
§Errors
Will return IndexError
if row
is out of range.
Auto Trait Implementations§
impl<'a> Freeze for EdgeTable<'a>
impl<'a> RefUnwindSafe for EdgeTable<'a>
impl<'a> !Send for EdgeTable<'a>
impl<'a> !Sync for EdgeTable<'a>
impl<'a> Unpin for EdgeTable<'a>
impl<'a> UnwindSafe for EdgeTable<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more