File tree 8 files changed +22
-22
lines changed
8 files changed +22
-22
lines changed Original file line number Diff line number Diff line change @@ -66,9 +66,9 @@ impl Iterator for EdgeTableIterator {
66
66
67
67
/// An immutable view of an edge table.
68
68
///
69
- /// These are not created directly.
70
- /// Instead, use [`TableAccess::edges`](crate::TableAccess::edges)
71
- /// to get a reference to an existing edge table;
69
+ /// These are not created directly but are accessed
70
+ /// by types implementing [`std::ops::Deref`] to
71
+ /// [`crate::table_views::TableViews`]
72
72
#[ repr( transparent) ]
73
73
pub struct EdgeTable {
74
74
pub ( crate ) table_ : NonNull < ll_bindings:: tsk_edge_table_t > ,
Original file line number Diff line number Diff line change @@ -47,9 +47,9 @@ impl PartialEq for IndividualTableRow {
47
47
48
48
/// An immutable view of a individual table.
49
49
///
50
- /// These are not created directly.
51
- /// Instead, use [`TableAccess::individuals`](crate::TableAccess::individuals)
52
- /// to get a reference to an existing node table;
50
+ /// These are not created directly but are accessed
51
+ /// by types implementing [`std::ops::Deref`] to
52
+ /// [`crate::table_views::TableViews`]
53
53
pub struct IndividualTable {
54
54
table_ : NonNull < ll_bindings:: tsk_individual_table_t > ,
55
55
}
Original file line number Diff line number Diff line change @@ -92,7 +92,7 @@ pub mod prelude;
92
92
mod site_table;
93
93
mod table_collection;
94
94
mod table_iterator;
95
- mod table_views;
95
+ pub mod table_views;
96
96
mod traits;
97
97
mod tree_interface;
98
98
mod trees;
Original file line number Diff line number Diff line change @@ -75,9 +75,9 @@ impl Iterator for MigrationTableIterator {
75
75
76
76
/// An immutable view of a migration table.
77
77
///
78
- /// These are not created directly.
79
- /// Instead, use [`TableAccess::migrations`](crate::TableAccess::migrations)
80
- /// to get a reference to an existing node table;
78
+ /// These are not created directly but are accessed
79
+ /// by types implementing [`std::ops::Deref`] to
80
+ /// [`crate::table_views::TableViews`]
81
81
pub struct MigrationTable {
82
82
table_ : NonNull < ll_bindings:: tsk_migration_table_t > ,
83
83
}
Original file line number Diff line number Diff line change @@ -78,9 +78,9 @@ impl Iterator for MutationTableIterator {
78
78
79
79
/// An immutable view of site table.
80
80
///
81
- /// These are not created directly.
82
- /// Instead, use [`TableAccess::mutations`](crate::TableAccess::mutations)
83
- /// to get a reference to an existing mutation table;
81
+ /// These are not created directly but are accessed
82
+ /// by types implementing [`std::ops::Deref`] to
83
+ /// [`crate::table_views::TableViews`]
84
84
pub struct MutationTable {
85
85
table_ : NonNull < ll_bindings:: tsk_mutation_table_t > ,
86
86
}
Original file line number Diff line number Diff line change @@ -68,9 +68,9 @@ impl Iterator for NodeTableIterator {
68
68
69
69
/// An immtable view of a node table.
70
70
///
71
- /// These are not created directly.
72
- /// Instead, use [`TableAccess::nodes`](crate::TableAccess::nodes)
73
- /// to get a reference to an existing node table;
71
+ /// These are not created directly but are accessed
72
+ /// by types implementing [`std::ops::Deref`] to
73
+ /// [`crate::table_views::TableViews`]
74
74
pub struct NodeTable {
75
75
table_ : NonNull < ll_bindings:: tsk_node_table_t > ,
76
76
}
Original file line number Diff line number Diff line change @@ -63,9 +63,9 @@ impl Iterator for PopulationTableIterator {
63
63
64
64
/// An immutable view of site table.
65
65
///
66
- /// These are not created directly.
67
- /// Instead, use [`TableAccess::populations`](crate::TableAccess::populations)
68
- /// to get a reference to an existing population table;
66
+ /// These are not created directly but are accessed
67
+ /// by types implementing [`std::ops::Deref`] to
68
+ /// [`crate::table_views::TableViews`]
69
69
#[ repr( transparent) ]
70
70
pub struct PopulationTable {
71
71
table_ : NonNull < ll_bindings:: tsk_population_table_t > ,
Original file line number Diff line number Diff line change @@ -63,9 +63,9 @@ impl Iterator for SiteTableIterator {
63
63
64
64
/// An immutable view of site table.
65
65
///
66
- /// These are not created directly.
67
- /// Instead, use [`TableAccess::sites`](crate::TableAccess::sites)
68
- /// to get a reference to an existing site table;
66
+ /// These are not created directly but are accessed
67
+ /// by types implementing [`std::ops::Deref`] to
68
+ /// [`crate::table_views::TableViews`]
69
69
pub struct SiteTable {
70
70
table_ : NonNull < ll_bindings:: tsk_site_table_t > ,
71
71
}
You can’t perform that action at this time.
0 commit comments