Move current migrator to a legacy module

Signed-off-by: Victor Porof <victor.porof@gmail.com>

src/backend.rs

@@ -17,6 +17,9 @@ pub use common::*;
 pub use traits::*;
 
 pub use impl_lmdb::{
+    ArchMigrateError as LmdbArchMigrateError,
+    ArchMigrateResult as LmdbArchMigrateResult,
+    ArchMigrator as LmdbArchMigrator,
     DatabaseFlagsImpl as LmdbDatabaseFlags,
     DatabaseImpl as LmdbDatabase,
     EnvironmentBuilderImpl as Lmdb,

src/backend/impl_lmdb.rs

@@ -8,6 +8,8 @@
 // CONDITIONS OF ANY KIND, either express or implied. See the License for the
 // specific language governing permissions and limitations under the License.
 
+mod arch_migrator;
+mod arch_migrator_error;
 mod cursor;
 mod database;
 mod environment;
@@ -18,6 +20,11 @@ mod iter;
 mod stat;
 mod transaction;
 
+pub use arch_migrator::{
+    MigrateError as ArchMigrateError,
+    MigrateResult as ArchMigrateResult,
+    Migrator as ArchMigrator,
+};
 pub use cursor::{
     RoCursorImpl,
     RwCursorImpl,

src/backend/impl_lmdb/arch_migrator.rs

@@ -44,7 +44,7 @@
 //! new environment in a temporary directory:
 //!
 //! ```
-//! use rkv::migrate::Migrator;
+//! use rkv::migrator::LmdbArchMigrator as Migrator;
 //! use std::path::Path;
 //! use tempfile::tempdir;
 //! let mut migrator = Migrator::new(Path::new("tests/envs/ref_env_32")).unwrap();
@@ -89,7 +89,7 @@ use lmdb::{
     WriteFlags,
 };
 
-pub use crate::error::MigrateError;
+pub use super::arch_migrator_error::MigrateError;
 
 const PAGESIZE: u16 = 4096;
 

src/backend/impl_lmdb/arch_migrator_error.rs

@@ -0,0 +1,107 @@
+// Copyright 2018-2019 Mozilla
+//
+// Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+// this file except in compliance with the License. You may obtain a copy of the
+// License at http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software distributed
+// under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+// CONDITIONS OF ANY KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations under the License.
+
+use std::{
+    io,
+    num,
+    str,
+};
+
+use failure::Fail;
+
+#[derive(Debug, Fail)]
+pub enum MigrateError {
+    #[fail(display = "database not found: {:?}", _0)]
+    DatabaseNotFound(String),
+
+    #[fail(display = "{}", _0)]
+    FromString(String),
+
+    #[fail(display = "couldn't determine bit depth")]
+    IndeterminateBitDepth,
+
+    #[fail(display = "I/O error: {:?}", _0)]
+    IoError(io::Error),
+
+    #[fail(display = "invalid DatabaseFlags bits")]
+    InvalidDatabaseBits,
+
+    #[fail(display = "invalid data version")]
+    InvalidDataVersion,
+
+    #[fail(display = "invalid magic number")]
+    InvalidMagicNum,
+
+    #[fail(display = "invalid NodeFlags bits")]
+    InvalidNodeBits,
+
+    #[fail(display = "invalid PageFlags bits")]
+    InvalidPageBits,
+
+    #[fail(display = "invalid page number")]
+    InvalidPageNum,
+
+    #[fail(display = "lmdb backend error: {}", _0)]
+    LmdbError(lmdb::Error),
+
+    #[fail(display = "string conversion error")]
+    StringConversionError,
+
+    #[fail(display = "TryFromInt error: {:?}", _0)]
+    TryFromIntError(num::TryFromIntError),
+
+    #[fail(display = "unexpected Page variant")]
+    UnexpectedPageVariant,
+
+    #[fail(display = "unexpected PageHeader variant")]
+    UnexpectedPageHeaderVariant,
+
+    #[fail(display = "unsupported PageHeader variant")]
+    UnsupportedPageHeaderVariant,
+
+    #[fail(display = "UTF8 error: {:?}", _0)]
+    Utf8Error(str::Utf8Error),
+}
+
+impl From<io::Error> for MigrateError {
+    fn from(e: io::Error) -> MigrateError {
+        MigrateError::IoError(e)
+    }
+}
+
+impl From<str::Utf8Error> for MigrateError {
+    fn from(e: str::Utf8Error) -> MigrateError {
+        MigrateError::Utf8Error(e)
+    }
+}
+
+impl From<num::TryFromIntError> for MigrateError {
+    fn from(e: num::TryFromIntError) -> MigrateError {
+        MigrateError::TryFromIntError(e)
+    }
+}
+
+impl From<&str> for MigrateError {
+    fn from(e: &str) -> MigrateError {
+        MigrateError::FromString(e.to_string())
+    }
+}
+
+impl From<String> for MigrateError {
+    fn from(e: String) -> MigrateError {
+        MigrateError::FromString(e)
+    }
+}
+
+impl From<lmdb::Error> for MigrateError {
+    fn from(e: lmdb::Error) -> MigrateError {
+        MigrateError::LmdbError(e)
+    }
+}

src/bin/dump.rs

@@ -14,12 +14,12 @@ use std::{
     path::Path,
 };
 
-use rkv::{
-    migrate::Migrator,
-    MigrateError,
+use rkv::migrator::{
+    LmdbArchMigrateError,
+    LmdbArchMigrator,
 };
 
-fn main() -> Result<(), MigrateError> {
+fn main() -> Result<(), LmdbArchMigrateError> {
     let mut cli_args = args();
     let mut db_name = None;
     let mut env_path = None;
@@ -47,7 +47,7 @@ fn main() -> Result<(), MigrateError> {
     }
 
     let env_path = env_path.ok_or("must provide a path to the LMDB environment")?;
-    let mut migrator: Migrator = Migrator::new(Path::new(&env_path))?;
+    let mut migrator = LmdbArchMigrator::new(Path::new(&env_path))?;
     migrator.dump(db_name.as_deref(), io::stdout()).unwrap();
 
     Ok(())

src/error.rs

@@ -10,7 +10,6 @@
 
 use std::{
     io,
-    num,
     path::PathBuf,
     str,
     thread,
@@ -121,102 +120,3 @@ impl From<io::Error> for StoreError {
         StoreError::IoError(e)
     }
 }
-
-#[derive(Debug, Fail)]
-pub enum MigrateError {
-    #[fail(display = "database not found: {:?}", _0)]
-    DatabaseNotFound(String),
-
-    #[fail(display = "{}", _0)]
-    FromString(String),
-
-    #[fail(display = "couldn't determine bit depth")]
-    IndeterminateBitDepth,
-
-    #[fail(display = "I/O error: {:?}", _0)]
-    IoError(io::Error),
-
-    #[fail(display = "invalid DatabaseFlags bits")]
-    InvalidDatabaseBits,
-
-    #[fail(display = "invalid data version")]
-    InvalidDataVersion,
-
-    #[fail(display = "invalid magic number")]
-    InvalidMagicNum,
-
-    #[fail(display = "invalid NodeFlags bits")]
-    InvalidNodeBits,
-
-    #[fail(display = "invalid PageFlags bits")]
-    InvalidPageBits,
-
-    #[fail(display = "invalid page number")]
-    InvalidPageNum,
-
-    #[fail(display = "lmdb backend error: {}", _0)]
-    LmdbError(lmdb::Error),
-
-    #[fail(display = "safe mode backend error: {}", _0)]
-    SafeModeError(SafeModeError),
-
-    #[fail(display = "string conversion error")]
-    StringConversionError,
-
-    #[fail(display = "TryFromInt error: {:?}", _0)]
-    TryFromIntError(num::TryFromIntError),
-
-    #[fail(display = "unexpected Page variant")]
-    UnexpectedPageVariant,
-
-    #[fail(display = "unexpected PageHeader variant")]
-    UnexpectedPageHeaderVariant,
-
-    #[fail(display = "unsupported PageHeader variant")]
-    UnsupportedPageHeaderVariant,
-
-    #[fail(display = "UTF8 error: {:?}", _0)]
-    Utf8Error(str::Utf8Error),
-}
-
-impl From<io::Error> for MigrateError {
-    fn from(e: io::Error) -> MigrateError {
-        MigrateError::IoError(e)
-    }
-}
-
-impl From<str::Utf8Error> for MigrateError {
-    fn from(e: str::Utf8Error) -> MigrateError {
-        MigrateError::Utf8Error(e)
-    }
-}
-
-impl From<num::TryFromIntError> for MigrateError {
-    fn from(e: num::TryFromIntError) -> MigrateError {
-        MigrateError::TryFromIntError(e)
-    }
-}
-
-impl From<&str> for MigrateError {
-    fn from(e: &str) -> MigrateError {
-        MigrateError::FromString(e.to_string())
-    }
-}
-
-impl From<String> for MigrateError {
-    fn from(e: String) -> MigrateError {
-        MigrateError::FromString(e)
-    }
-}
-
-impl From<lmdb::Error> for MigrateError {
-    fn from(e: lmdb::Error) -> MigrateError {
-        MigrateError::LmdbError(e)
-    }
-}
-
-impl From<SafeModeError> for MigrateError {
-    fn from(e: SafeModeError) -> MigrateError {
-        MigrateError::SafeModeError(e)
-    }
-}

src/lib.rs

@@ -209,7 +209,7 @@ mod manager;
 mod readwrite;
 
 pub mod backend;
-pub mod migrate;
+pub mod migrator;
 pub mod store;
 pub mod value;
 
@@ -221,7 +221,6 @@ pub use backend::{
 pub use env::Rkv;
 pub use error::{
     DataError,
-    MigrateError,
     StoreError,
 };
 pub use manager::Manager;

src/migrator.rs

@@ -0,0 +1,15 @@
+// Copyright 2018-2019 Mozilla
+//
+// Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+// this file except in compliance with the License. You may obtain a copy of the
+// License at http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software distributed
+// under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+// CONDITIONS OF ANY KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations under the License.
+
+pub use crate::backend::{
+    LmdbArchMigrateError,
+    LmdbArchMigrateResult,
+    LmdbArchMigrator,
+};