Struct EdgeTable

Source
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>

Source

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

Return the number of rows

Source

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.

Source

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.

Source

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.

Source

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.