style: Rename all OwnedX tables to OwningX. (#408)

BREAKING CHANGE: changed name of public type.

Author: molpopgen

src/edge_table.rs

@@ -345,9 +345,9 @@ build_owned_table_type!(
     /// # Examples
     ///
     /// ```
-    /// use tskit::OwnedEdgeTable;
+    /// use tskit::OwningEdgeTable;
     ///
-    /// let mut edges = OwnedEdgeTable::default();
+    /// let mut edges = OwningEdgeTable::default();
     /// let rowid = edges.add_row(1., 2., 0, 1).unwrap();
     /// assert_eq!(rowid, 0);
     /// assert_eq!(edges.num_rows(), 1);
@@ -361,7 +361,7 @@ build_owned_table_type!(
     ///
     /// ```
     /// # #[cfg(any(feature="doc", feature="derive"))] {
-    /// use tskit::OwnedEdgeTable;
+    /// use tskit::OwningEdgeTable;
     ///
     /// #[derive(serde::Serialize,
     ///          serde::Deserialize,
@@ -373,7 +373,7 @@ build_owned_table_type!(
     ///
     /// let metadata = EdgeMetadata{value: 42};
     ///
-    /// let mut edges = OwnedEdgeTable::default();
+    /// let mut edges = OwningEdgeTable::default();
     ///
     /// let rowid = edges.add_row_with_metadata(0., 1., 5, 10, &metadata).unwrap();
     /// assert_eq!(rowid, 0);
@@ -387,15 +387,15 @@ build_owned_table_type!(
     /// }
     /// # }
     /// ```
-    => OwnedEdgeTable,
+    => OwningEdgeTable,
     EdgeTable,
     tsk_edge_table_t,
     tsk_edge_table_init,
     tsk_edge_table_free,
     crate::bindings::tsk_edge_table_clear
 );
 
-impl OwnedEdgeTable {
+impl OwningEdgeTable {
     edge_table_add_row!(=> add_row, self, *self.table);
     edge_table_add_row_with_metadata!(=> add_row_with_metadata, self, *self.table);
 }

src/individual_table.rs

@@ -459,9 +459,9 @@ build_owned_table_type!(
     /// # Examples
     ///
     /// ```
-    /// use tskit::OwnedIndividualTable;
+    /// use tskit::OwningIndividualTable;
     ///
-    /// let mut individuals = OwnedIndividualTable::default();
+    /// let mut individuals = OwningIndividualTable::default();
     /// let rowid = individuals.add_row(0, None, None).unwrap();
     /// assert_eq!(rowid, 0);
     /// assert_eq!(individuals.num_rows(), 1);
@@ -473,7 +473,7 @@ build_owned_table_type!(
     ///
     /// ```
     /// # #[cfg(any(feature="doc", feature="derive"))] {
-    /// use tskit::OwnedIndividualTable;
+    /// use tskit::OwningIndividualTable;
     ///
     /// #[derive(serde::Serialize,
     ///          serde::Deserialize,
@@ -485,7 +485,7 @@ build_owned_table_type!(
     ///
     /// let metadata = IndividualMetadata{value: 42};
     ///
-    /// let mut individuals = OwnedIndividualTable::default();
+    /// let mut individuals = OwningIndividualTable::default();
     ///
     /// let rowid = individuals.add_row_with_metadata(0, None, None, &metadata).unwrap();
     /// assert_eq!(rowid, 0);
@@ -500,15 +500,15 @@ build_owned_table_type!(
     ///
     /// # }
     /// ```
-    => OwnedIndividualTable,
+    => OwningIndividualTable,
     IndividualTable,
     tsk_individual_table_t,
     tsk_individual_table_init,
     tsk_individual_table_free,
     crate::bindings::tsk_individual_table_clear
 );
 
-impl OwnedIndividualTable {
+impl OwningIndividualTable {
     individual_table_add_row!(=> add_row, self, *self.table);
     individual_table_add_row_with_metadata!(=> add_row_with_metadata, self, *self.table);
 }

src/lib.rs

@@ -427,15 +427,15 @@ impl_time_position_arithmetic!(Position, Time);
 /// "Null" identifier value.
 pub(crate) const TSK_NULL: tsk_id_t = -1;
 
-pub use edge_table::{EdgeTable, EdgeTableRow, OwnedEdgeTable};
+pub use edge_table::{EdgeTable, EdgeTableRow, OwningEdgeTable};
 pub use error::TskitError;
 pub use flags::*;
-pub use individual_table::{IndividualTable, IndividualTableRow, OwnedIndividualTable};
-pub use migration_table::{MigrationTable, MigrationTableRow, OwnedMigrationTable};
-pub use mutation_table::{MutationTable, MutationTableRow, OwnedMutationTable};
-pub use node_table::{NodeTable, NodeTableRow, OwnedNodeTable};
-pub use population_table::{OwnedPopulationTable, PopulationTable, PopulationTableRow};
-pub use site_table::{OwnedSiteTable, SiteTable, SiteTableRow};
+pub use individual_table::{IndividualTable, IndividualTableRow, OwningIndividualTable};
+pub use migration_table::{MigrationTable, MigrationTableRow, OwningMigrationTable};
+pub use mutation_table::{MutationTable, MutationTableRow, OwningMutationTable};
+pub use node_table::{NodeTable, NodeTableRow, OwningNodeTable};
+pub use population_table::{OwningPopulationTable, PopulationTable, PopulationTableRow};
+pub use site_table::{OwningSiteTable, SiteTable, SiteTableRow};
 pub use table_collection::TableCollection;
 pub use traits::IndividualLocation;
 pub use traits::IndividualParents;

src/migration_table.rs

@@ -410,9 +410,9 @@ build_owned_table_type!(
     /// # Examples
     ///
     /// ```
-    /// use tskit::OwnedMigrationTable;
+    /// use tskit::OwningMigrationTable;
     ///
-    /// let mut migrations = OwnedMigrationTable::default();
+    /// let mut migrations = OwningMigrationTable::default();
     /// let rowid = migrations.add_row((0., 1.), 1, (0, 1), 10.3).unwrap();
     /// assert_eq!(rowid, 0);
     /// assert_eq!(migrations.num_rows(), 1);
@@ -423,7 +423,7 @@ build_owned_table_type!(
     ///
     /// ```
     /// # #[cfg(any(feature="doc", feature="derive"))] {
-    /// use tskit::OwnedMigrationTable;
+    /// use tskit::OwningMigrationTable;
     ///
     /// #[derive(serde::Serialize,
     ///          serde::Deserialize,
@@ -435,7 +435,7 @@ build_owned_table_type!(
     ///
     /// let metadata = MigrationMetadata{value: 42};
     ///
-    /// let mut migrations = OwnedMigrationTable::default();
+    /// let mut migrations = OwningMigrationTable::default();
     ///
     /// let rowid = migrations.add_row_with_metadata((0., 1.), 1, (0, 1), 10.3, &metadata).unwrap();
     /// assert_eq!(rowid, 0);
@@ -450,15 +450,15 @@ build_owned_table_type!(
     ///
     /// # }
     /// ```
-    => OwnedMigrationTable,
+    => OwningMigrationTable,
     MigrationTable,
     tsk_migration_table_t,
     tsk_migration_table_init,
     tsk_migration_table_free,
     ll_bindings::tsk_migration_table_clear
 );
 
-impl OwnedMigrationTable {
+impl OwningMigrationTable {
     migration_table_add_row!(=> add_row, self, *self.table);
     migration_table_add_row_with_metadata!(=> add_row_with_metadata, self, *self.table);
 }

src/mutation_table.rs

@@ -377,9 +377,9 @@ build_owned_table_type!(
 /// # Examples
 ///
 /// ```
-/// use tskit::OwnedMutationTable;
+/// use tskit::OwningMutationTable;
 ///
-/// let mut mutations = OwnedMutationTable::default();
+/// let mut mutations = OwningMutationTable::default();
 /// let rowid = mutations.add_row(1, 2, 0, 1.0, None).unwrap();
 /// assert_eq!(rowid, 0);
 /// assert_eq!(mutations.num_rows(), 1);
@@ -390,7 +390,7 @@ build_owned_table_type!(
 ///
 /// ```
 /// # #[cfg(any(feature="doc", feature="derive"))] {
-/// use tskit::OwnedMutationTable;
+/// use tskit::OwningMutationTable;
 ///
 /// #[derive(serde::Serialize,
 ///          serde::Deserialize,
@@ -402,7 +402,7 @@ build_owned_table_type!(
 ///
 /// let metadata = MutationMetadata{value: 42};
 ///
-/// let mut mutations = OwnedMutationTable::default();
+/// let mut mutations = OwningMutationTable::default();
 ///
 /// let rowid = mutations.add_row_with_metadata(0, 1, 5, 10.0, None, &metadata).unwrap();
 /// assert_eq!(rowid, 0);
@@ -416,15 +416,15 @@ build_owned_table_type!(
 /// }
 /// # }
 /// ```
-    => OwnedMutationTable,
+    => OwningMutationTable,
     MutationTable,
     tsk_mutation_table_t,
     tsk_mutation_table_init,
     tsk_mutation_table_free,
     ll_bindings::tsk_mutation_table_clear
 );
 
-impl OwnedMutationTable {
+impl OwningMutationTable {
     mutation_table_add_row!(=> add_row, self, *self.table);
     mutation_table_add_row_with_metadata!(=> add_row_with_metadata, self, *self.table);
 }

src/node_table.rs

@@ -514,13 +514,13 @@ impl NodeTable {
     /// # assert!(flags.iter().all(|f| f.is_sample()));
     /// ```
     ///
-    /// ## Standalone tables
+    /// ## Owning tables
     ///
     /// The ownership semantics differ when tables are not part of a
     /// table collection:
     ///
     /// ```
-    /// let mut nodes = tskit::OwnedNodeTable::default();
+    /// let mut nodes = tskit::OwningNodeTable::default();
     /// assert!(nodes.add_row(tskit::NodeFlags::IS_SAMPLE, 10., -1, -1).is_ok());
     /// # assert_eq!(nodes.num_rows(), 1);
     /// let flags = nodes.flags_slice_mut();
@@ -565,9 +565,9 @@ build_owned_table_type!(
     /// # Examples
     ///
     /// ```
-    /// use tskit::OwnedNodeTable;
+    /// use tskit::OwningNodeTable;
     ///
-    /// let mut nodes = OwnedNodeTable::default();
+    /// let mut nodes = OwningNodeTable::default();
     /// let rowid = nodes.add_row(0, 1.1, -1, -1).unwrap();
     /// assert_eq!(rowid, 0);
     /// assert_eq!(nodes.num_rows(), 1);
@@ -578,7 +578,7 @@ build_owned_table_type!(
     ///
     /// ```
     /// # #[cfg(any(feature="doc", feature="derive"))] {
-    /// use tskit::OwnedNodeTable;
+    /// use tskit::OwningNodeTable;
     ///
     /// #[derive(serde::Serialize,
     ///          serde::Deserialize,
@@ -590,7 +590,7 @@ build_owned_table_type!(
     ///
     /// let metadata = NodeMetadata{value: 42};
     ///
-    /// let mut nodes = OwnedNodeTable::default();
+    /// let mut nodes = OwningNodeTable::default();
     ///
     /// let rowid = nodes.add_row_with_metadata(0, 1., -1, -1, &metadata).unwrap();
     /// assert_eq!(rowid, 0);
@@ -605,15 +605,15 @@ build_owned_table_type!(
     ///
     /// # }
     /// ```
-    => OwnedNodeTable,
+    => OwningNodeTable,
     NodeTable,
     tsk_node_table_t,
     tsk_node_table_init,
     tsk_node_table_free,
     ll_bindings::tsk_node_table_clear
 );
 
-impl OwnedNodeTable {
+impl OwningNodeTable {
     node_table_add_row!(=> add_row, self, (*self.table));
     node_table_add_row_with_metadata!(=> add_row_with_metadata, self, (*self.table));
 }
@@ -624,7 +624,7 @@ mod test_owned_node_table {
 
     #[test]
     fn test_add_row() {
-        let mut nodes = OwnedNodeTable::default();
+        let mut nodes = OwningNodeTable::default();
         let rowid = nodes.add_row(0, 1.1, -1, -1).unwrap();
         assert_eq!(rowid, 0);
         assert_eq!(nodes.num_rows(), 1);

src/population_table.rs

@@ -223,9 +223,9 @@ build_owned_table_type!(
 /// # Examples
 ///
 /// ```
-/// use tskit::OwnedPopulationTable;
+/// use tskit::OwningPopulationTable;
 ///
-/// let mut populations = OwnedPopulationTable::default();
+/// let mut populations = OwningPopulationTable::default();
 /// let rowid = populations.add_row().unwrap();
 /// assert_eq!(rowid, 0);
 /// assert_eq!(populations.num_rows(), 1);
@@ -236,7 +236,7 @@ build_owned_table_type!(
 ///
 /// ```
 /// # #[cfg(any(feature="doc", feature="derive"))] {
-/// use tskit::OwnedPopulationTable;
+/// use tskit::OwningPopulationTable;
 ///
 /// #[derive(serde::Serialize,
 ///          serde::Deserialize,
@@ -248,7 +248,7 @@ build_owned_table_type!(
 ///
 /// let metadata = PopulationMetadata{name: "YRB".to_string()};
 ///
-/// let mut populations = OwnedPopulationTable::default();
+/// let mut populations = OwningPopulationTable::default();
 ///
 /// let rowid = populations.add_row_with_metadata(&metadata).unwrap();
 /// assert_eq!(rowid, 0);
@@ -262,15 +262,15 @@ build_owned_table_type!(
 /// }
 /// # }
 /// ```
-    => OwnedPopulationTable,
+    => OwningPopulationTable,
     PopulationTable,
     tsk_population_table_t,
     tsk_population_table_init,
     tsk_population_table_free,
     ll_bindings::tsk_population_table_clear
 );
 
-impl OwnedPopulationTable {
+impl OwningPopulationTable {
     population_table_add_row!(=> add_row, self, *self.table);
     population_table_add_row_with_metadata!(=> add_row_with_metadata, self, *self.table);
 }

src/provenance.rs

@@ -287,22 +287,22 @@ build_owned_table_type!(
     /// # #[cfg(feature = "provenance")]
     /// # #[cfg_attr(doc_cfg, doc(cfg(feature = "provenance")))]
     /// {
-    /// use tskit::provenance::OwnedProvenanceTable;
-    /// let mut provenances = OwnedProvenanceTable::default();
+    /// use tskit::provenance::OwningProvenanceTable;
+    /// let mut provenances = OwningProvenanceTable::default();
     /// let id = provenances.add_row("message").unwrap();
     /// assert_eq!(id, 0);
     /// assert_eq!(provenances.num_rows(), 1);
     /// # }
     /// ```
-    => OwnedProvenanceTable,
+    => OwningProvenanceTable,
     ProvenanceTable,
     tsk_provenance_table_t,
     tsk_provenance_table_init,
     tsk_provenance_table_free,
     ll_bindings::tsk_provenance_table_clear
 );
 
-impl OwnedProvenanceTable {
+impl OwningProvenanceTable {
     provenance_table_add_row!(=> add_row, self, *self.table);
 }