safety

tskit-dev · Jul 21, 2022 · c1dc8ff · c1dc8ff
1 parent cfd22ac
commit c1dc8ff
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/table_collection.rs b/src/table_collection.rs
@@ -1067,6 +1067,8 @@ impl TableCollection {
     /// # assert_eq!(migrations.num_rows(), 0);
     /// ```
     pub fn set_migrations(&mut self, migrations: &crate::OwnedMigrationTable) -> TskReturnValue {
+        // SAFETY: neither self nor edges are possible
+        // to create with null pointers.
         let rv = unsafe {
             ll_bindings::tsk_migration_table_set_columns(
                 &mut (*self.inner).migrations,
@@ -1103,6 +1105,8 @@ impl TableCollection {
     /// # assert_eq!(populations.num_rows(), 0);
     /// ```
     pub fn set_populations(&mut self, populations: &crate::OwnedPopulationTable) -> TskReturnValue {
+        // SAFETY: neither self nor edges are possible
+        // to create with null pointers.
         let rv = unsafe {
             ll_bindings::tsk_population_table_set_columns(
                 &mut (*self.inner).populations,
@@ -1140,6 +1144,8 @@ impl TableCollection {
         &mut self,
         provenances: &crate::provenance::OwnedProvenanceTable,
     ) -> TskReturnValue {
+        // SAFETY: neither self nor edges are possible
+        // to create with null pointers.
         let rv = unsafe {
             ll_bindings::tsk_provenance_table_set_columns(
                 &mut (*self.inner).provenances,