Tidy up the old codebase for Rust Edition 2024.

1. Remove the ability to retrieve the name of synchronization points, along with all related functions.
2. Update Rust Edition to version 2024.
3. Update `tokio` and exclude `async-trait`.
4. Simplify the writing of synchronized and synchronized_point macros by shortening their names.
5. Conduct general refactoring.
6. Add missing configuration files: `.editorconfig`, `rustfmt.toml`, and `rust-toolchain.toml`.
7. Simplify the writing of code generator macros.
8. Change the structure of the `core.rs` and `async_core.rs` files.
9. Remove `build.rs` and slightly rework functions.
10. Update documentation.
11. Fix strange naming warnings and address requirements flagged by clippy.

Author: denisandroid

.github/workflows/CI.yml

@@ -2,9 +2,13 @@ name: CI
 
 on:
   push:
-    branches: [ master ]
+    branches:
+      - master
+      - dev
   pull_request:
-    branches: [ master ]
+    branches:
+      - master
+      - dev
 
 env:
   CARGO_TERM_COLOR: always
@@ -35,8 +39,8 @@ jobs:
     - name: Run cargo alltest
       run: cargo test --all-features --verbose
     - name: Std
-      run: cargo test --no-default-features --features std,point,get_point_name --lib --verbose --examples
+      run: cargo test --no-default-features --features std,point --lib --verbose --examples
     - name: PL
-      run: cargo test --no-default-features --features parking_lot,point,get_point_name --lib --verbose --examples
+      run: cargo test --no-default-features --features parking_lot,point --lib --verbose --examples
     - name: ASYNC(TOKIO+PL)
-      run: cargo test --no-default-features --features async,point,get_point_name --lib --verbose --tests
+      run: cargo test --no-default-features --features async,point --lib --verbose --tests

Cargo.toml

@@ -1,10 +1,9 @@
 [package]
 name = "synchronized"
-version = "1.0.4"
+version = "1.1.0"
 authors = ["Denis Kotlyarov (Денис Котляров) <denis2005991@gmail.com>"]
 repository = "https://github.com/clucompany/synchronized.git"
-edition = "2021"
-build = "build.rs"
+edition = "2024"
 
 license = "Apache-2.0"
 readme = "README.md"
@@ -21,10 +20,8 @@ all-features = true
 rustdoc-args = ["--cfg", "docsrs"]
 
 [features]
-default = ["std", "point", "get_point_name"]
-# Ability to get the name of the synchronization point.
-get_point_name = []
-# Adds or removes support for the `synchronized_point` macro.
+default = ["std", "point"]
+# Adds or removes support for the `sync_point` macro.
 point = []
 # Use synchronization primitives from `std`. Note that is_lock is not supported in it.
 #
@@ -33,12 +30,11 @@ std = []
 
 # The synchronization primitive is implemented using the `tokio`+`parking_lot` 
 # library for an asynchronous environment.
-async = ["tokio", "async-trait"]
+async = ["tokio"]
 
 [dependencies]
 # The synchronization primitive is implemented using the `parking_lot` library.
-parking_lot =	{ version = "0.12.1", optional = true }
+parking_lot = { version = "0.12.3", optional = true }
 
 # The synchronization primitive is implemented using the `tokio`+`parking_lot` library.
-tokio = { version = "1.21.2", optional = true, default-features = false, features = ["parking_lot", "sync"]}
-async-trait =	{ version = "0.1.58", optional = true }
+tokio = { version = "1.44.2", optional = true, default-features = false, features = ["parking_lot", "sync"]}

README.md

@@ -11,7 +11,7 @@ Convenient and simple macro for code synchronization in multithreading.
 ### 1. easy/sync
 
 ```rust
-use synchronized::synchronized;
+use synchronized::sync;
 
 /*
 	Quick implementation examples of blocking anonymous code.
@@ -20,21 +20,21 @@ use synchronized::synchronized;
 fn main() {
 	// #1 Anonymous inter-threaded synchronized code, 
 	// in the case of multi-threading, one thread will wait for the completion of another.
-	synchronized! {
+	sync! {
 		println!("1");
 	}
 
 	// #2 Anonymous inter-threaded synchronized code, 
 	// in the case of multi-threading, one thread will wait for the completion of another.
-	synchronized!( println!("1"); );
+	sync!( println!("1"); );
 }
 ```
 
 ### 2. sync_static
 
 ```rust
 use std::thread::spawn;
-use synchronized::synchronized;
+use synchronized::sync;
 
 /*
 	A more illustrative example of code blocking implementation 
@@ -73,7 +73,7 @@ fn sync_fn() -> usize {
 	//
 	// The code will never run at the same time. If one thread is executing 
 	// this code, the second thread will wait for this code to finish executing.
-	let result = synchronized! {
+	let result = sync! {
 		static mut POINT0: usize = 0;
 		static mut POINT1: usize = 0;
 
@@ -93,7 +93,7 @@ fn sync_fn() -> usize {
 
 ```rust
 use std::thread::spawn;
-use synchronized::synchronized;
+use synchronized::sync;
 
 /*
 	An example that describes how to quickly create an anonymous 
@@ -111,7 +111,7 @@ fn main() {
 	for thread_id in 0..5 {
 		let join = spawn(move || {
 			// Create anonymous synchronized code with one mutable variable `sync_let` and `count`.
-			let result = synchronized!(
+			let result = sync!(
 				(sync_let: String = String::new(), count: usize = 0) {
 					// If it's the first thread, 
 					// then theoretically `sync_let` is String::new().
@@ -167,21 +167,12 @@ fn main() {
 	!!! In this example, the assembly requires the `point` feature to be active.
 */
 
-#[cfg( feature = "point" )]
-use synchronized::synchronized_point;
-#[cfg( feature = "point" )]
-use synchronized::synchronized;
-
-#[cfg( not(feature = "point") )]
-macro_rules! synchronized_point {
-	[ $($unk:tt)* ] => {
-		println!("!!! This example requires support for the `point` feature. Run the example with `cargo run --example point --all-features`.");
-	};
-}
+use synchronized::sync_point;
+use synchronized::sync;
 
 fn main() {
 	// A sync point named `COMB_SYNC` to group anonymous code syncs by name.
-	synchronized_point! {(COMB_SYNC) {
+	sync_point! {(COMB_SYNC) {
 		static mut POINT: usize = 0;
 		println!("GeneralSyncPoint, name_point: {}", COMB_SYNC.get_sync_point_name());
 
@@ -190,7 +181,7 @@ fn main() {
 		//
 		// This code is not executed concurrently in a multi-threaded environment, 
 		// one thread is waiting for someone else's code to execute in this part of the code.
-		let result0 = synchronized! ((->COMB_SYNC) {
+		let result0 = sync! ((->COMB_SYNC) {
 			println!("SyncCode, name_point: {}", COMB_SYNC.get_sync_point_name());
 			unsafe {
 				POINT += 1;
@@ -208,7 +199,7 @@ fn main() {
 		// Note that `result0` and `result1` cannot be calculated at the same time, 
 		// this does not happen because `result0` or `result1` are calculated in 
 		// synchronized code with a single sync point of the same name.
-		let result1 = synchronized! ((->COMB_SYNC) {
+		let result1 = sync! ((->COMB_SYNC) {
 			println!("SyncCode, name_point: {}", COMB_SYNC.get_sync_point_name());
 			unsafe {
 				POINT += 1;
@@ -238,7 +229,6 @@ default-features = false
 features = [
 	"std",
 	#"point",
-	#"get_point_name"
 ]
 ```
 
@@ -248,12 +238,11 @@ For a `synchronized` macro, use the primitives implemented by the default `parki
 
 ```rust,ignore
 [dependencies.synchronized]
-version = "1.0.4"
+version = "1.1.0"
 default-features = false
 features = [
 	"parking_lot",
 	#"point",
-	#"get_point_name"
 ]
 ```
 
@@ -263,12 +252,11 @@ For a `synchronized` macro, use the primitives implemented by the default `tokio
 
 ```rust,ignore
 [dependencies.synchronized]
-version = "1.0.4"
+version = "1.1.0"
 default-features = false
 features = [
 	"async",
 	#"point",
-	#"get_point_name"
 ]
 ```
 
@@ -280,6 +268,6 @@ features = [
 
 # License
 
-Copyright 2022 #UlinProject Denis Kotlyarov (Денис Котляров)
+Copyright 2022-2025 #UlinProject Denis Kotlyarov (Денис Котляров)
 
 Licensed under the Apache License, Version 2.0

build.rs

@@ -1,66 +1,52 @@
-
 /*
-	An example implementation of synchronized code with 
+	An example implementation of synchronized code with
 	one non-anonymous synchronization point.
-	
-	This example creates a set of anonymous sync codes associated with a 
-	single named sync point. Each synchronization code executes in the same 
-	way as ordinary anonymous code, but execution occurs simultaneously in a 
+
+	This example creates a set of anonymous sync codes associated with a
+	single named sync point. Each synchronization code executes in the same
+	way as ordinary anonymous code, but execution occurs simultaneously in a
 	multi-threaded environment in only one of them.
-	
+
 	!!! In this example, the assembly requires the `point` feature to be active.
 */
 
-#[cfg( feature = "point" )]
-use synchronized::synchronized_point;
-#[cfg( feature = "point" )]
-use synchronized::synchronized;
-
-#[cfg( not(feature = "point") )]
-macro_rules! synchronized_point {
-	[ $($unk:tt)* ] => {
-		println!("!!! This example requires support for the `point` feature. Run the example with `cargo run --example point --all-features`.");
-	};
-}
+use synchronized::{sync, sync_point};
 
 fn main() {
 	// A sync point named `COMB_SYNC` to group anonymous code syncs by name.
-	synchronized_point! {(COMB_SYNC) {
+	sync_point! {(COMB_SYNC) {
 		static mut POINT: usize = 0;
-		println!("GeneralSyncPoint, name_point: {}", COMB_SYNC.get_sync_point_name());
-		
-		// #1 Anonymous synchronized code that operates on a 
+
+		// #1 Anonymous synchronized code that operates on a
 		// single named synchronization point.
 		//
-		// This code is not executed concurrently in a multi-threaded environment, 
+		// This code is not executed concurrently in a multi-threaded environment,
 		// one thread is waiting for someone else's code to execute in this part of the code.
-		let result0 = synchronized! ((->COMB_SYNC) {
-			println!("SyncCode, name_point: {}", COMB_SYNC.get_sync_point_name());
+		let result0 = sync! ((->COMB_SYNC) {
 			unsafe {
 				POINT += 1;
-				
+
 				POINT
 			}
 		});
-		
+
 		// This line of code is not synchronized and can run concurrently on all threads.
 		println!("Unsynchronized code");
-		
-		// #2 Anonymous synchronized code that operates on a 
+
+		// #2 Anonymous synchronized code that operates on a
 		// single named synchronization point.
 		//
-		// Note that `result0` and `result1` cannot be calculated at the same time, 
-		// this does not happen because `result0` or `result1` are calculated in 
+		// Note that `result0` and `result1` cannot be calculated at the same time,
+		// this does not happen because `result0` or `result1` are calculated in
 		// synchronized code with a single sync point of the same name.
-		let result1 = synchronized! ((->COMB_SYNC) {
-			println!("SyncCode, name_point: {}", COMB_SYNC.get_sync_point_name());
+		let result1 = sync! ((->COMB_SYNC) {
 			unsafe {
 				POINT += 1;
-				
+
 				POINT
 			}
 		});
-		
+
 		// Display debug information.
 		println!("result, res0: {:?}, res1: {:?}", result0, result1);
 	}}