RUST: Split the rust part of lektor into multiple modules

CMakeLists.txt

@@ -349,7 +349,7 @@ ExternalProject_Add(liblektor_rs
     SOURCE_DIR        "${CMAKE_SOURCE_DIR}/src/rust/liblektor-rs"
     BUILD_COMMAND     ${RUST_BUILD_CMD}
     COMMAND           ${RUST_BUILD_CMD}
-    BUILD_BYPRODUCTS  "${CMAKE_SOURCE_DIR}/src/rust/target/${RUST_BUILD_TYPE}/liblektor_rs.a"
+    BUILD_BYPRODUCTS  "${CMAKE_SOURCE_DIR}/src/rust/target/${RUST_BUILD_TYPE}/liblektor_unsafe.a"
     BUILD_ALWAYS      1
     BUILD_IN_SOURCE   1
 )
@@ -358,7 +358,7 @@ add_dependencies(lektord liblektor_rs)
 
 target_link_libraries(lektord
     PRIVATE
-    "${CMAKE_SOURCE_DIR}/src/rust/target/${RUST_BUILD_TYPE}/liblektor_rs.a"
+    "${CMAKE_SOURCE_DIR}/src/rust/target/${RUST_BUILD_TYPE}/liblektor_unsafe.a"
     ${MPV_LIBRARY}
     ${CMAKE_DL_LIBS}
     ${SQLITE3_LIBRARY}

README.md

@@ -68,6 +68,14 @@ the correct sqlite support on your system:
 cargo install diesel_cli --no-default-features --features sqlite
 ```
 
+To visualize dependencies of the rust part of lektor, you can write the
+following commands from the root of each rust workspaces:
+
+```sh
+cargo install cargo-depgraph
+cargo depgraph --all-deps --dedup-transitive-deps | dot -Tpng > dependencies.png
+```
+
 ### Building instructions
 
 The manual way of installing and setting up lektor:

lektor.code-workspace

@@ -28,6 +28,8 @@
         "json.format.enable": true,
         "rust-analyzer.checkOnSave.command": "clippy",
         "rust-analyzer.inlayHints.parameterHints.enable": false,
-        "rust-analyzer.procMacro.attributes.enable": true
+        "rust-analyzer.diagnostics.enable": true,
+        "rust-analyzer.procMacro.enable": true,
+        "rust-analyzer.procMacro.attributes.enable": true,
     }
 }
\ No newline at end of file

src/rust/liblektor-rs/Cargo.toml

-[package]
-name = "lektor-rs"
-version = "0.1.0"
-edition = "2021"
+[workspace]
+resolver = "2"
+members = [
+    "lektor_c_compat",
+    "lektor_db",
+    "lektor_repo",
+    "lektor_unsafe",
+    "kurisu_api",
+]
 
-[lib]
-crate-type = ["staticlib"]
+[workspace.package]
+edition = "2021"
+authors = ["Maël MARTIN"]
+version = "0.1.0"
+license = "MIT"
 
-[dependencies]
+[workspace.dependencies]
 log = "0.4"
 libc = "0.2.0"
 diesel_migrations = "2"

src/rust/liblektor-rs/kurisu_api/Cargo.toml

+[package]
+name = "kurisu_api"
+version.workspace = true
+edition.workspace = true
+authors.workspace = true
+license.workspace = true
+
+[dependencies]
+log.workspace = true
+serde.workspace = true

src/rust/liblektor-rs/lektor_c_compat/Cargo.toml

+[package]
+name = "lektor_c_compat"
+version.workspace = true
+edition.workspace = true
+authors.workspace = true
+license.workspace = true
+
+[dependencies]
+log.workspace = true
+libc.workspace = true

src/rust/liblektor-rs/src/compat.rs → src/rust/liblektor-rs/lektor_c_compat/src/c_types.rs

-pub const LEKTOR_TAG_MAX: usize = 256;
+//! Types defined in the C part of the project. Don't use them from safe C code,
+//! only use the safe wrappers.
 
 pub struct LktQueue;
 pub struct LktDb;

src/rust/liblektor-rs/lektor_c_compat/src/lib.rs

+//! Defines functions and types that matches the one defined in the C part of
+//! the lektor source code.
+//!
+//! From safe rust code you *must not* use the types defined in the [c_types]
+//! module.
+
+pub mod c_types;
+
+pub use libc::{c_char, c_int, c_long, c_void, size_t};
+
+/// The maximal length of a tag in lektor.
+pub const LEKTOR_TAG_MAX: usize = 256;

src/rust/liblektor-rs/lektor_db/Cargo.toml

+[package]
+name = "lektor_db"
+version.workspace = true
+edition.workspace = true
+authors.workspace = true
+license.workspace = true
+
+[dependencies]
+log.workspace = true
+serde.workspace = true
+
+diesel_migrations = "2"
+diesel = { version = "2", default-features = false, features = ["sqlite"] }
+
+kurisu_api = { path = "../kurisu_api" }

src/rust/liblektor-rs/build.rs → src/rust/liblektor-rs/lektor_db/build.rs

@@ -34,7 +34,7 @@ fn main() {
         .canonicalize()
         .expect("failed to canonicalize OUT_DIR");
     let source_dir = out_dir
-        .join("../../../../../liblektor-rs")
+        .join("../../../../../liblektor-rs/lektor_db")
         .canonicalize()
         .expect("failed to canonicalize the source path");
     let migration_dir = source_dir

src/rust/liblektor-rs/src/database/connexion.rs → src/rust/liblektor-rs/lektor_db/src/connexion.rs

-use super::{
+use crate::{
+    models::*,
     queue::{LktDatabasePriority, LktDatabaseQueueRangeIter},
     *,
 };
-use crate::{database::models::*, kurisu_api::v1 as api_v1};
-use diesel_migrations::{embed_migrations, EmbeddedMigrations, MigrationHarness};
-
-/// The migrations!
-const MIGRATIONS: EmbeddedMigrations = embed_migrations!();
-
-/// Run migrations in a connexion!
-fn run_migration(conn: &mut SqliteConnection) -> Result<(), String> {
-    conn.run_pending_migrations(MIGRATIONS)
-        .map_err(|err| err.to_string())
-        .map(|_| ())
-}
+use kurisu_api::v1 as api_v1;
 
 /// Create a connexion to a database and run automatically the migrations.
 fn establish_connection(path: impl AsRef<str>) -> Result<SqliteConnection, String> {
+    use diesel_migrations::{embed_migrations, EmbeddedMigrations, MigrationHarness};
+    const MIGRATIONS: EmbeddedMigrations = embed_migrations!();
     let mut conn = SqliteConnection::establish(path.as_ref())
         .map_err(|err| format!("error connecting to {}: {}", path.as_ref(), err))?;
-    self::run_migration(&mut conn)?;
+    conn.run_pending_migrations(MIGRATIONS)
+        .map_err(|err| err.to_string())?;
     Ok(conn)
 }
 
@@ -32,7 +25,9 @@ pub struct LktDatabaseConnection {
 /// expression...
 macro_rules! with_dsl {
     ($table: ident => $expr: expr) => {{
+        #[allow(unused_imports)]
         use self::schema::$table::dsl::*;
+        #[allow(unused_imports)]
         use diesel::dsl::*;
         $expr
     }};

src/rust/liblektor-rs/src/database/error.rs → src/rust/liblektor-rs/lektor_db/src/error.rs

-use super::*;
-
 pub enum LktDatabaseError {
     DieselConnection(diesel::ConnectionError),
     DieselResult(diesel::result::Error),

src/rust/liblektor-rs/src/database/mod.rs → src/rust/liblektor-rs/lektor_db/src/lib.rs

@@ -5,11 +5,9 @@ pub mod error;
 pub mod models;
 pub mod queue;
 pub mod schema;
-pub mod unsafe_interface;
 
 pub(self) use diesel::prelude::*;
 pub(self) use error::*;
-pub(self) use log::*;
 pub(self) use std::{
     collections::VecDeque,
     ops::{Index, Range},