1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
use crate::bindings as ll_bindings;
use crate::metadata;
use crate::TskitError;
use crate::{tsk_id_t, tsk_size_t};
/// An immutable view of site table.
///
/// These are not created directly.
/// Instead, use [`TableCollection::sites`](crate::TableCollection::sites)
/// to get a reference to an existing site table;
pub struct SiteTable<'a> {
table_: &'a ll_bindings::tsk_site_table_t,
}
impl<'a> SiteTable<'a> {
pub(crate) fn new_from_table(sites: &'a ll_bindings::tsk_site_table_t) -> Self {
SiteTable { table_: sites }
}
/// Return the number of rows
pub fn num_rows(&'a self) -> tsk_size_t {
self.table_.num_rows
}
/// Return the ``position`` value from row ``row`` of the table.
///
/// # Errors
///
/// Will return [``IndexError``](crate::TskitError::IndexError)
/// if ``row`` is out of range.
pub fn position(&'a self, row: tsk_id_t) -> Result<f64, TskitError> {
unsafe_tsk_column_access!(row, 0, self.num_rows(), self.table_.position)
}
/// Get the ``ancestral_state`` value from row ``row`` of the table.
///
/// # Return
///
/// Will return `None` if there is no ancestral state.
///
/// # Errors
///
/// Will return [``IndexError``](crate::TskitError::IndexError)
/// if ``row`` is out of range.
pub fn ancestral_state(&'a self, row: tsk_id_t) -> Result<Option<Vec<u8>>, TskitError> {
crate::metadata::char_column_to_vector(
self.table_.ancestral_state,
self.table_.ancestral_state_offset,
row,
self.table_.num_rows,
self.table_.ancestral_state_length,
)
}
pub fn metadata<T: metadata::MetadataRoundtrip>(
&'a self,
row: tsk_id_t,
) -> Result<Option<T>, TskitError> {
let buffer = metadata_to_vector!(T, self, row);
decode_metadata_row!(T, buffer)
}
}