Add ::clear(&self) to all owned tables. (#290)

Author: molpopgen

src/_macros.rs

@@ -534,7 +534,7 @@ macro_rules! handle_metadata_return {
 }
 
 macro_rules! build_owned_tables {
-    ($name: ty, $deref: ident, $llname: ty, $init: ident, $free: ident) => {
+    ($name: ty, $deref: ident, $llname: ty, $init: ident, $free: ident, $clear: expr) => {
         impl $name {
             fn new() -> Self {
                 let temp = unsafe { libc::malloc(std::mem::size_of::<$llname>()) as *mut $llname };
@@ -547,6 +547,12 @@ macro_rules! build_owned_tables {
                 assert_eq!(rv, 0);
                 Self { table }
             }
+
+            /// Clear the table.
+            pub fn clear(&mut self) -> $crate::TskReturnValue {
+                let rv = unsafe { $clear(self.as_mut_ptr()) };
+                handle_tsk_return_value!(rv)
+            }
         }
 
         impl Default for $name {
@@ -1019,7 +1025,12 @@ macro_rules! provenance_table_add_row {
 }
 
 macro_rules! build_owned_table_type {
-    ($(#[$attr:meta])* => $name: ident, $deref_type: ident, $tskname: ident, $tskinit: ident, $tskfree: ident) => {
+    ($(#[$attr:meta])* => $name: ident,
+    $deref_type: ident,
+    $tskname: ident,
+    $tskinit: ident,
+    $tskfree: ident,
+    $tskclear: expr) => {
         $(#[$attr])*
         pub struct $name {
             table: mbox::MBox<$crate::bindings::$tskname>,
@@ -1030,7 +1041,8 @@ macro_rules! build_owned_table_type {
             $deref_type,
             $crate::bindings::$tskname,
             $tskinit,
-            $tskfree
+            $tskfree,
+            $tskclear
         );
     };
 }

src/edge_table.rs

@@ -182,6 +182,9 @@ build_owned_table_type!(
     /// let rowid = edges.add_row(1., 2., 0, 1).unwrap();
     /// assert_eq!(rowid, 0);
     /// assert_eq!(edges.num_rows(), 1);
+    ///
+    /// edges.clear().unwrap();
+    /// assert_eq!(edges.num_rows(), 0);
     /// ```
     ///
     /// An example with metadata.
@@ -218,7 +221,8 @@ build_owned_table_type!(
     EdgeTable,
     tsk_edge_table_t,
     tsk_edge_table_init,
-    tsk_edge_table_free
+    tsk_edge_table_free,
+    crate::bindings::tsk_edge_table_clear
 );
 
 impl OwnedEdgeTable {

src/individual_table.rs

@@ -328,7 +328,8 @@ build_owned_table_type!(
     IndividualTable,
     tsk_individual_table_t,
     tsk_individual_table_init,
-    tsk_individual_table_free
+    tsk_individual_table_free,
+    crate::bindings::tsk_individual_table_clear
 );
 
 impl OwnedIndividualTable {

src/migration_table.rs

@@ -262,7 +262,8 @@ build_owned_table_type!(
     MigrationTable,
     tsk_migration_table_t,
     tsk_migration_table_init,
-    tsk_migration_table_free
+    tsk_migration_table_free,
+    ll_bindings::tsk_migration_table_clear
 );
 
 impl OwnedMigrationTable {

src/mutation_table.rs

@@ -246,7 +246,8 @@ build_owned_table_type!(
     MutationTable,
     tsk_mutation_table_t,
     tsk_mutation_table_init,
-    tsk_mutation_table_free
+    tsk_mutation_table_free,
+    ll_bindings::tsk_mutation_table_clear
 );
 
 impl OwnedMutationTable {

src/node_table.rs

@@ -293,7 +293,8 @@ build_owned_table_type!(
     NodeTable,
     tsk_node_table_t,
     tsk_node_table_init,
-    tsk_node_table_free
+    tsk_node_table_free,
+    ll_bindings::tsk_node_table_clear
 );
 
 impl OwnedNodeTable {

src/population_table.rs

@@ -165,7 +165,8 @@ build_owned_table_type!(
     PopulationTable,
     tsk_population_table_t,
     tsk_population_table_init,
-    tsk_population_table_free
+    tsk_population_table_free,
+    ll_bindings::tsk_population_table_clear
 );
 
 impl OwnedPopulationTable {

src/provenance.rs

@@ -196,7 +196,8 @@ build_owned_table_type!(
     ProvenanceTable,
     tsk_provenance_table_t,
     tsk_provenance_table_init,
-    tsk_provenance_table_free
+    tsk_provenance_table_free,
+    ll_bindings::tsk_provenance_table_clear
 );
 
 impl OwnedProvenanceTable {

src/site_table.rs

@@ -202,7 +202,8 @@ build_owned_table_type!(
     SiteTable,
     tsk_site_table_t,
     tsk_site_table_init,
-    tsk_site_table_free
+    tsk_site_table_free,
+    ll_bindings::tsk_site_table_clear
 );
 
 impl OwnedSiteTable {