enclose-1.2.0/.cargo_vcs_info.json 0000644 00000000136 00000000001 0012464 0 ustar {
"git": {
"sha1": "1a7879730e4f20113211366fbfc9a3b77a9c5fc2"
},
"path_in_vcs": ""
} enclose-1.2.0/.editorconfig 0000644 0000000 0000000 00000000470 10461020230 0013732 0 ustar 0000000 0000000 # EditorConfig helps developers define and maintain consistent
# coding styles between different editors and IDEs
# http://editorconfig.org
root = true
[*.rs]
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = false
insert_final_newline = false
indent_style = tab
indent_size = 5
max_line_length = 80
enclose-1.2.0/.github/workflows/CI.yml 0000644 0000000 0000000 00000001256 10461020230 0015673 0 ustar 0000000 0000000 name: CI
on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
env:
CARGO_TERM_COLOR: always
jobs:
cargo-test:
strategy:
matrix:
os: [ubuntu-latest]
runs-on: ${{ matrix.os }}
steps:
- uses: actions/cache@v3
with:
path: |
~/.cargo/bin/
~/.cargo/registry/index/
~/.cargo/registry/cache/
~/.cargo/git/db/
target/
key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
- uses: actions/checkout@v3
- name: Run cargo deftest
run: cargo test --verbose
- name: Run cargo alltest
run: cargo test --all-features --verbose
enclose-1.2.0/.gitignore 0000644 0000000 0000000 00000000500 10461020230 0013237 0 ustar 0000000 0000000 # Generated by Cargo
# will have compiled files and executables
/target/
# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
Cargo.lock
# These are backup files generated by rustfmt
**/*.rs.bk
enclose-1.2.0/CODE_OF_CONDUCT.md 0000644 0000000 0000000 00000001637 10461020230 0014062 0 ustar 0000000 0000000
## Description
Our community is dedicated to providing a respectful and inclusive environment for everyone, regardless of gender, age, sexual orientation, disability, physical appearance, body size, race, nationality, or religion.
We encourage open and constructive communication, and we expect all participants to be respectful and considerate towards others.
## Where to Find the Full Code of Conduct
You can find our full Code of Conduct at [link](https://github.com/clucompany/code_of_conduct/blob/main/README.md). Please make sure to review and adhere to it to help us create a positive community for all.
Thank you for contributing to our community!
enclose-1.2.0/Cargo.lock 0000644 00000000227 00000000001 0010440 0 ustar # This file is automatically @generated by Cargo.
# It is not intended for manual editing.
version = 3
[[package]]
name = "enclose"
version = "1.2.0"
enclose-1.2.0/Cargo.toml 0000644 00000001727 00000000001 0010471 0 ustar # THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
#
# When uploading crates to the registry Cargo will automatically
# "normalize" Cargo.toml files for maximal compatibility
# with all versions of Cargo and also rewrite `path` dependencies
# to registry (e.g., crates.io) dependencies.
#
# If you are reading this file be aware that the original Cargo.toml
# will likely look very different (and much more reasonable).
# See Cargo.toml.orig for the original contents.
[package]
edition = "2021"
name = "enclose"
version = "1.2.0"
authors = ["Denis Kotlyarov (Денис Котляров) "]
description = "A convenient macro, for cloning values into a closure."
homepage = "https://crates.io/crates/enclose"
readme = "README.md"
keywords = [
"enclose",
"enclose_macro",
"macro",
"no_std",
"clucompany",
]
categories = ["development-tools"]
license = "MIT/Apache-2.0"
repository = "https://github.com/clucompany/Enclose.git"
[dependencies]
enclose-1.2.0/Cargo.toml.orig 0000644 0000000 0000000 00000000756 10461020230 0014153 0 ustar 0000000 0000000 [package]
name = "enclose"
version = "1.2.0"
authors = ["Denis Kotlyarov (Денис Котляров) "]
repository = "https://github.com/clucompany/Enclose.git"
homepage = "https://crates.io/crates/enclose"
license = "MIT/Apache-2.0"
readme = "README.md"
edition = "2021"
description = "A convenient macro, for cloning values into a closure."
keywords = ["enclose", "enclose_macro", "macro", "no_std", "clucompany"]
categories = ["development-tools"]
[dependencies]
enclose-1.2.0/LICENSE_APACHE 0000755 0000000 0000000 00000026201 10461020230 0013266 0 ustar 0000000 0000000 Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2019-2024 #UlinProject (Denis Kotlyarov) Денис Котляров
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.
enclose-1.2.0/LICENSE_MIT 0000755 0000000 0000000 00000002134 10461020230 0012775 0 ustar 0000000 0000000 MIT License
Copyright 2019-2024 #UlinProject (Denis Kotlyarov) Денис Котляров
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
enclose-1.2.0/README.md 0000644 0000000 0000000 00000012134 10461020230 0012534 0 ustar 0000000 0000000
## Usage
Add this to your Cargo.toml:
```toml
[dependencies]
enclose = "1.2.0"
```
and this to your source code:
```rust
use enclose::enclose;
```
## Example
### EasyUse
Just use it!
```rust
use enclose::enclose;
fn main() {
let clone_data = 0;
let add_data = 100;
my_enclose( enclose!((mut clone_data, add_data) || {
// (mut clone_data, add_data) ->
// let mut clone_data = clone_data.clone();
// let add_data = add_data.clone();
println!("#0 {:?}", clone_data);
clone_data += add_data;
println!("#1 {:?}", clone_data);
assert_eq!(clone_data, 100);
}));
assert_eq!(clone_data, 0);
}
fn my_enclose R, R>(a: F) -> R {
a()
}
```
### MutexUse
Creating closures for a multi-threaded environment, no extra lines!
```rust
use std::sync::Arc;
use std::sync::Mutex;
use std::thread;
use enclose::enclose;
fn main() {
let mutex_data = Arc::new(Mutex::new( 0 ));
let thread = thread::spawn( enclose!((mutex_data => d) move || {
// (mutex_data => d) ->
// let d = mutex_data.clone();
let mut lock = match d.lock() {
Ok(a) => a,
Err(e) => e.into_inner(),
};
*lock += 1;
}));
thread.join().unwrap();
{
let lock = match mutex_data.lock() {
Ok(a) => a,
Err(e) => e.into_inner(),
};
assert_eq!(*lock, 1);
}
}
```
### ArcMutexUse
A more complex example of using an enclose macro in a multi-threaded environment.
```rust
use std::sync::Arc;
use std::sync::Mutex;
use std::sync::RwLock;
use std::thread;
use enclose::enclose;
fn main() {
let data1 = Arc::new(Mutex::new( 0 ));
let data2 = Arc::new(RwLock::new( (0, 2, 3, 4) ));
let count_thread = 5;
let mut waits = Vec::with_capacity(count_thread);
for _a in 0..count_thread {
waits.push({
thread::spawn( enclose!((data1, data2) move || {
// (data1, data2) ->
// let data1 = data1.clone();
// let data2 = data2.clone();
let mut v_lock = match data1.lock() {
Ok(a) => a,
Err(e) => e.into_inner(),
};
*v_lock += 1;
drop( data2 ); // ignore warning
}))
});
}
for a in waits {
a.join().unwrap();
}
{
// Check data1_lock
let data1_lock = match data1.lock() {
Ok(a) => a,
Err(e) => e.into_inner(),
};
assert_eq!(*data1_lock, 5);
}
{
// Check data2_lock
let data2_lock = match data2.write() {
Ok(a) => a,
Err(e) => e.into_inner(),
};
assert_eq!(*data2_lock, (0, 2, 3, 4));
}
}
```
### EasyCopy
Using copy instead of clone.
```rust
use enclose::enclose;
use std::sync::Arc;
fn main() {
let clone_data = Arc::new(0);
let add_data = Arc::new(100);
my_enclose( enclose!((mut *clone_data, *add_data) || {
// (mut *clone_data, *add_data)
// let mut clone_data = *clone_data;
// let add_data = *add_data;
println!("#0 {:?}", clone_data);
clone_data += add_data;
println!("#1 {:?}", clone_data);
assert_eq!(clone_data, 100);
}));
assert_eq!(*clone_data, 0);
}
fn my_enclose R, R>(a: F) -> R {
a()
}
```
See all
## License
This project has a dual license according to (LICENSE-MIT) and (LICENSE-APACHE-2-0).
Copyright (c) 2019-2024 #UlinProject
(Denis Kotlyarov).
### Apache License
Licensed under the Apache License, Version 2.0.
### MIT License
Licensed under the MIT License.
enclose-1.2.0/examples/expr.rs 0000644 0000000 0000000 00000001460 10461020230 0014417 0 ustar 0000000 0000000 use enclose::enclose;
use std::sync::Arc;
fn main() {
let clone_data = Arc::new(0);
let add_data = Arc::new(100);
// I also note that any expressions can be used, but the main thing is to
// put the @ symbol at the beginning of the variable, and not forget to assign
// a new name to the variable using =>.
my_enclose(
enclose!((@*clone_data => mut clone_data: usize, @*(add_data.clone()) => add_data) || {
// (@*clone_data => mut clone_data, @*(add_data.clone()) => add_data) ->
// let mut clone_data = *clone_data;
// let add_data = *(add_data.clone());
println!("#0 {:?}", clone_data);
clone_data += add_data;
println!("#1 {:?}", clone_data);
assert_eq!(clone_data, 100);
}),
);
assert_eq!(*clone_data, 0);
}
#[inline]
fn my_enclose R, R>(a: F) -> R {
a()
}
enclose-1.2.0/examples/justuse.rs 0000644 0000000 0000000 00000000742 10461020230 0015145 0 ustar 0000000 0000000 use enclose::enclose;
fn main() {
let clone_data = 0;
let add_data = 100;
my_enclose(enclose!((mut clone_data, add_data) || {
// (mut clone_data, add_data) ->
// let mut clone_data = clone_data.clone();
// let add_data = add_data.clone();
println!("#0 {:?}", clone_data);
clone_data += add_data;
println!("#1 {:?}", clone_data);
assert_eq!(clone_data, 100);
}));
assert_eq!(clone_data, 0);
}
#[inline]
fn my_enclose R, R>(a: F) -> R {
a()
}
enclose-1.2.0/examples/letscopy.rs 0000644 0000000 0000000 00000001001 10461020230 0015272 0 ustar 0000000 0000000 use enclose::enclose;
use std::sync::Arc;
fn main() {
let clone_data = Arc::new(0);
let add_data = Arc::new(100);
my_enclose(enclose!((mut *clone_data, *add_data) || {
// (mut *clone_data, *add_data) ->
// let mut clone_data = *clone_data;
// let add_data = *add_data;
println!("#0 {:?}", clone_data);
clone_data += add_data;
println!("#1 {:?}", clone_data);
assert_eq!(clone_data, 100);
}));
assert_eq!(*clone_data, 0);
}
#[inline]
fn my_enclose R, R>(a: F) -> R {
a()
}
enclose-1.2.0/examples/letsref.rs 0000644 0000000 0000000 00000000702 10461020230 0015103 0 ustar 0000000 0000000 use enclose::enclose;
fn main() {
let mut clone_data = 2;
my_enclose(enclose!((ref clone_data => mut ref_clone_data) || {
// (ref clone_data => mut ref_clone_data) ->
// let ref mut ref_clone_data = clone_data;
println!("#0 {:?}", ref_clone_data);
*ref_clone_data += 2;
println!("#1 {:?}", clone_data);
assert_eq!(clone_data, 4);
}));
assert_eq!(clone_data, 4);
}
#[inline]
fn my_enclose R, R>(a: F) -> R {
a()
}
enclose-1.2.0/examples/letsrename.rs 0000644 0000000 0000000 00000001061 10461020230 0015575 0 ustar 0000000 0000000 use std::sync::Arc;
use std::sync::Mutex;
use std::thread;
use enclose::enclose;
fn main() {
let mutex_data = Arc::new(Mutex::new(0));
let thread = thread::spawn(enclose!((mutex_data => d, @1024 => my_var) move || {
// (mutex_data => d) ->
// let d = mutex_data.clone();
// let my_var = 1024;
let mut lock = match d.lock() {
Ok(a) => a,
Err(e) => e.into_inner(),
};
*lock += my_var;
}));
thread.join().unwrap();
{
let lock = match mutex_data.lock() {
Ok(a) => a,
Err(e) => e.into_inner(),
};
assert_eq!(*lock, 1024);
}
}
enclose-1.2.0/examples/threads.rs 0000644 0000000 0000000 00000001316 10461020230 0015073 0 ustar 0000000 0000000 use std::sync::Arc;
use std::sync::Mutex;
use std::thread;
use enclose::enclose;
fn main() {
let mutex_left_data = Arc::new(Mutex::new(0));
let right_data = Arc::new(1);
let thread = thread::spawn(enclose!((mutex_left_data, right_data) move || {
// (mutex_left_data, right_data) ->
// let mutex_left_data = mutex_left_data.clone();
// let right_data = right_data.clone();
let mut lock = match mutex_left_data.lock() {
Ok(a) => a,
Err(e) => e.into_inner(),
};
*lock += *right_data;
}));
thread.join().unwrap();
{
let left_data = match mutex_left_data.lock() {
Ok(a) => a,
Err(e) => e.into_inner(),
};
assert_eq!(*left_data, *right_data);
// if *left_data == *right_data
}
}
enclose-1.2.0/rust-toolchain.toml 0000644 0000000 0000000 00000000036 10461020230 0015123 0 ustar 0000000 0000000 [toolchain]
channel = "stable" enclose-1.2.0/rustfmt.toml 0000644 0000000 0000000 00000000040 10461020230 0013647 0 ustar 0000000 0000000 tab_spaces = 4
hard_tabs = true
enclose-1.2.0/src/lib.rs 0000644 0000000 0000000 00000022525 10461020230 0013165 0 ustar 0000000 0000000 //Copyright (c) 2019-2024 #UlinProject Denis Kotlyarov (Денис Котляров)
//-----------------------------------------------------------------------------
//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.
//-----------------------------------------------------------------------------
// or
//-----------------------------------------------------------------------------
//Permission is hereby granted, free of charge, to any person obtaining a copy
//of this software and associated documentation files (the "Software"), to deal
//in the Software without restriction, including without limitation the rights
//to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//copies of the Software, and to permit persons to whom the Software is
//furnished to do so, subject to the following conditions:
//The above copyright notice and this permission notice shall be included in all
//copies or substantial portions of the Software.
//THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
//SOFTWARE.
// #Ulin Project 1819 2022 2024
/*!
A convenient macro, for cloning values into a closure.
### Use
Just use it!
```rust
use enclose::enclose;
fn main() {
let clone_data = 0;
let add_data = 100;
my_enclose( enclose!((mut clone_data, add_data) || {
// (mut clone_data, add_data) ->
// let mut clone_data = clone_data.clone();
// let add_data = add_data.clone();
println!("#0 {:?}", clone_data);
clone_data += add_data;
println!("#1 {:?}", clone_data);
assert_eq!(clone_data, 100);
}));
assert_eq!(clone_data, 0);
}
fn my_enclose R, R>(a: F) -> R {
a()
}
```
### MutexUse
Creating closures for a multi-threaded environment, no extra lines!
```rust
use std::sync::Arc;
use std::sync::Mutex;
use std::thread;
use enclose::enclose;
fn main() {
let mutex_data = Arc::new(Mutex::new( 0 ));
let thread = thread::spawn( enclose!((mutex_data => d) move || {
// (mutex_data => d) ->
// let d = mutex_data.clone();
let mut lock = match d.lock() {
Ok(a) => a,
Err(e) => e.into_inner(),
};
*lock += 1;
}));
thread.join().unwrap();
{
let lock = match mutex_data.lock() {
Ok(a) => a,
Err(e) => e.into_inner(),
};
assert_eq!(*lock, 1);
}
}
```
### ArcMutexUse
A more complex example of using an enclose macro in a multi-threaded environment.
```rust
use std::sync::Arc;
use std::sync::Mutex;
use std::sync::RwLock;
use std::thread;
use enclose::enclose;
fn main() {
let data1 = Arc::new(Mutex::new( 0 ));
let data2 = Arc::new(RwLock::new( (0, 2, 3, 4) ));
let count_thread = 5;
let mut waits = Vec::with_capacity(count_thread);
for _a in 0..count_thread {
waits.push({
thread::spawn( enclose!((data1, data2) move || {
// (data1, data2) ->
// let data1 = data1.clone();
// let data2 = data2.clone();
let mut v_lock = match data1.lock() {
Ok(a) => a,
Err(e) => e.into_inner(),
};
*v_lock += 1;
drop( data2 ); // ignore warning
}))
});
}
for a in waits {
a.join().unwrap();
}
{
// Check data1_lock
let data1_lock = match data1.lock() {
Ok(a) => a,
Err(e) => e.into_inner(),
};
assert_eq!(*data1_lock, 5);
}
{
// Check data2_lock
let data2_lock = match data2.write() {
Ok(a) => a,
Err(e) => e.into_inner(),
};
assert_eq!(*data2_lock, (0, 2, 3, 4));
}
}
```
### EasyCopy
Using copy instead of clone.
```rust
use enclose::enclose;
use std::sync::Arc;
fn main() {
let clone_data = Arc::new(0);
let add_data = Arc::new(100);
my_enclose( enclose!((mut *clone_data, *add_data) || {
// (mut *clone_data, *add_data)
// let mut clone_data = *clone_data;
// let add_data = *add_data;
println!("#0 {:?}", clone_data);
clone_data += add_data;
println!("#1 {:?}", clone_data);
assert_eq!(clone_data, 100);
}));
assert_eq!(*clone_data, 0);
}
fn my_enclose R, R>(a: F) -> R {
a()
}
```
*/
#![no_std]
#![allow(clippy::tabs_in_doc_comments)]
#![allow(clippy::needless_doctest_main)]
mod var;
/// A macro for creating a closure, as well as cloning,
/// copying values into the closure.
///
/// ## Args Support
///
/// A list of all possible arguments that can be written, separated by commas,
/// in the arguments to the macro.
///
/// ### `.clone()` operation
/// ```code
/// // (a => mut b: String) will be converted to (let mut b: String = a.clone();)
/// // (b => mut b)
/// // (a => b: usize)
/// // (a => b)
/// // (mut a: String)
/// // (mut a)
/// // (a: String)
/// // (a)
/// ```
///
/// ### `*copy` operation
/// ```code
/// // (*a => mut b: &str) will be converted to (let mut b: &str = *a;)
/// // (*a => mut b)
/// // (*a => b: &str)
/// // (*a => b)
/// // (mut *a: &str)
/// // (mut *a)
/// // (*a: &str)
/// // (*a)
/// ```
///
/// ### `let ref mut a = b;` (`ref`) operation
/// ```code
/// // (ref mut a: String) will be converted to (let ref mut a: String = a;)
/// // (ref mut a)
/// // (ref a: String)
/// // (ref a)
/// // (ref a => mut b: String)
/// // (ref a => mut b)
/// // (ref a => b: String)
/// // (ref a => b)
/// ```
///
/// ### `(1+1)` (expr) operation
/// ```code
/// // (@(1+1) => mut b: usize) will be converted to (let mut b: usize = (1+1);)
/// // (@(1+1) => mut b)
/// // (@(1+1) => b: usize)
/// // (@(1+1) => b)
/// ```
///
/// ### `let a = b;` (move) operation
/// ```code
/// // (move a => mut b: String) will be converted to (let mut b: String = a;)
/// // (move a => mut b)
/// // (move a => mut b)
/// // (move a => b: String)
/// // (move a => b)
/// // (move mut a: String)
/// // (move mut a)
/// // (move a: String)
/// // (move a)
/// ```
///
/// ### `{println!("test");}` (run) operation
/// ```code
/// // { panic!("12"); }
/// ```
///
/// ## Example
///
/// ### JustUse
///
/// ```rust
/// use enclose::enclose;
///
///fn main() {
/// let clone_data = 0;
/// let add_data = 100;
///
/// my_enclose(enclose!((mut clone_data, add_data) || {
/// // (mut clone_data, add_data) ->
/// // let mut clone_data = clone_data.clone();
/// // let add_data = add_data.clone();
///
/// println!("#0 {:?}", clone_data);
/// clone_data += add_data;
/// println!("#1 {:?}", clone_data);
///
/// assert_eq!(clone_data, 100);
/// }));
///
/// assert_eq!(clone_data, 0);
///}
///
///#[inline]
///fn my_enclose R, R>(a: F) -> R {
/// a()
///}
///```
///
/// ### Expr
///
///```rust
///use enclose::enclose;
///use std::sync::Arc;
///
///fn main() {
/// let clone_data = Arc::new(0);
/// let add_data = Arc::new(100);
///
/// // I also note that any expressions can be used, but the main thing is to
/// // put the @ symbol at the beginning of the variable, and not forget to assign
/// // a new name to the variable using =>.
/// my_enclose(
/// enclose!((@*clone_data => mut clone_data: usize, @*(add_data.clone()) => add_data) || {
/// // (@*clone_data => mut clone_data, @*(add_data.clone()) => add_data) ->
/// // let mut clone_data = *clone_data;
/// // let add_data = *(add_data.clone());
///
/// println!("#0 {:?}", clone_data);
/// clone_data += add_data;
/// println!("#1 {:?}", clone_data);
///
/// assert_eq!(clone_data, 100);
/// }),
/// );
///
/// assert_eq!(*clone_data, 0);
///}
///
///#[inline]
///fn my_enclose R, R>(a: F) -> R {
/// a()
///}
/// ```
///
#[macro_export]
macro_rules! enclose {
[
// (a, b) move || true
( $($enc_args:tt)* ) move || $($b:tt)*
] => {{ // move, empty args
$crate::enclose_var! {
$( $enc_args )*
}
move || $($b)*
}};
[
// (a, b) move |c, d| true
( $($enc_args:tt)* ) move | $($args:tt),* | $($b:tt)*
] => {{ // move, args
$crate::enclose_var! {
$( $enc_args )*
}
move | $($args),* | $($b)*
}};
[
// (a, b) || true
( $($enc_args:tt)* ) || $($b:tt)*
] => {{ // empty args
|| {
$crate::enclose_var! {
$( $enc_args )*
}
$($b)*
}
}};
[
// (a, b) |c, d| true
( $($enc_args:tt)* ) | $($args:tt),* | $($b:tt)*
] => {{ // args
| $($args),* | {
$crate::enclose_var! {
$( $enc_args )*
}
$($b)*
}
}};
[
// (a, b) true
( $($enc_args:tt)* ) $($all:tt)*
] => {{ // empty
$crate::enclose_var! {
$( $enc_args )*
}
$($all)*
}};
/*[ $($unk:tt)+ ] => {
compile_error!("Undefined entry or unsupported arguments, please double-check input.");
};*/
[] => {};
}
/// A macro for creating a closure, as well as cloning,
/// copying values into the closure.
///
/// Alternative short record `enclose`.
#[macro_export]
macro_rules! enc {
[
// (a, b) move || true
// (a, b) move |c, d| true
// (a, b) || true
// (a, b) |c, d| true
// (a, b) true
$($tt:tt)*
] => {
$crate::enclose! {
$($tt)*
}
};
}
enclose-1.2.0/src/var.rs 0000644 0000000 0000000 00000013260 10461020230 0013203 0 ustar 0000000 0000000 /// A macro that generates code for working with variables based on input data.
///
/// (usually for internal use only)
///
/// ## Support
///
/// ### `.clone()` operation
/// ```code
/// // (a => mut b: String) will be converted to (let mut b: String = a.clone();)
/// // (b => mut b)
/// // (a => b: usize)
/// // (a => b)
/// // (mut a: String)
/// // (mut a)
/// // (a: String)
/// // (a)
/// ```
///
/// ### `*copy` operation
/// ```code
/// // (*a => mut b: &str) will be converted to (let mut b: &str = *a;)
/// // (*a => mut b)
/// // (*a => b: &str)
/// // (*a => b)
/// // (mut *a: &str)
/// // (mut *a)
/// // (*a: &str)
/// // (*a)
/// ```
///
/// ### `let ref mut a = b;`(`ref`) operation
/// ```code
/// // (ref mut a: String) will be converted to (let ref mut a: String = a;)
/// // (ref mut a)
/// // (ref a: String)
/// // (ref a)
/// // (ref a => mut b: String)
/// // (ref a => mut b)
/// // (ref a => b: String)
/// // (ref a => b)
/// ```
///
/// ### `(1+1)` (expr) operation
/// ```code
/// // (@(1+1) => mut b: usize) will be converted to (let mut b: usize = (1+1);)
/// // (@(1+1) => mut b)
/// // (@(1+1) => b: usize)
/// // (@(1+1) => b)
/// ```
///
/// ### `let a = b;` (move) operation
/// ```code
/// // (move a => mut b: String) will be converted to (let mut b: String = a;)
/// // (move a => mut b)
/// // (move a => mut b)
/// // (move a => b: String)
/// // (move a => b)
/// // (move mut a: String)
/// // (move mut a)
/// // (move a: String)
/// // (move a)
/// ```
///
/// ### `{println!("test");}` (run) operation
/// ```code
/// // { panic!("12"); }
/// ```
#[macro_export]
macro_rules! enclose_var {
[
// ref operation
// (ref a => mut b: String)
// (ref a => mut b)
ref $a: expr => mut $b: ident $(: $ty:ty)?
$(, $($tt:tt)+ )?
] => {
let ref mut $b $(: $ty)? = $a;
$(
$crate::enclose_var! {
$($tt)+
}
)?
};
[
// ref operation
// (ref a => b: String)
// (ref a => b)
ref $a: expr => $b: ident $(: $ty:ty)?
$(, $($tt:tt)+ )?
] => {
let ref $b $(: $ty)? = $a;
$(
$crate::enclose_var! {
$($tt)+
}
)?
};
//
[
// move operation
// (move a => mut b: String)
// (move a => mut b)
move $a: expr => mut $b: ident $(: $ty:ty)?
$(, $($tt:tt)+ )?
] => {
let mut $b $(: $ty)? = $a;
$(
$crate::enclose_var! {
$($tt)+
}
)?
};
[
// move operation
// (move a => b: String)
// (move a => b)
move $a: expr => $b: ident $(: $ty:ty)?
$(, $($tt:tt)+ )?
] => {
let $b $(: $ty)? = $a;
$(
$crate::enclose_var! {
$($tt)+
}
)?
};
//
[
// copy operation
// (*a => mut b: &str)
// (*a => mut b)
*$a: expr => mut $b: ident $(: $ty:ty)?
$(, $($tt:tt)+ )?
] => {
let mut $b $(: $ty)? = *$a;
$(
$crate::enclose_var! {
$($tt)+
}
)?
};
[
// copy operation
// (*a => b: String)
// (*a => b)
*$a: expr => $b: ident $(: $ty:ty)?
$(, $($tt:tt)+ )?
] => {
let $b $(: $ty)? = *$a;
$(
$crate::enclose_var! {
$($tt)+
}
)?
};
//
[
// expr
// (@(1+1) => mut b: usize)
// (@(1+1) => mut b)
@$a: expr => mut $b: ident $(: $ty:ty)?
$(, $($tt:tt)+ )?
] => {
let mut $b $(: $ty)? = $a;
$(
$crate::enclose_var! {
$($tt)+
}
)?
};
[
// expr
// (@(1+1) => b: usize)
// (@(1+1) => b)
@$a: expr => $b: ident $(: $ty:ty)?
$(, $($tt:tt)+ )?
] => {
let $b $(: $ty)? = $a;
$(
$crate::enclose_var! {
$($tt)+
}
)?
};
//
[
// ref
// (ref mut a: String)
// (ref mut a)
ref mut $a: ident $(: $ty:ty)?
$(, $($tt:tt)+)?
] => {
let ref mut $a $(: $ty)? = $a;
$(
$crate::enclose_var! {
$($tt)+
}
)?
};
[
// ref
// (ref a: String)
// (ref a)
ref $a: ident $(: $ty:ty)?
$(, $($tt:tt)+)?
] => {
let ref $a $(: $ty)? = $a;
$(
$crate::enclose_var! {
$($tt)+
}
)?
};
// end
[
// move
// (move mut a: String)
// (move mut a)
move mut $a: ident $(: $ty:ty)?
$(, $($tt:tt)+)?
] => {
let mut $a $(: $ty)? = $a;
$(
$crate::enclose_var! {
$($tt)+
}
)?
};
[
// move
// (move a: String)
// (move a)
move $a: ident $(: $ty:ty)?
$(, $($tt:tt)+)?
] => {
let $a $(: $ty)? = $a;
$(
$crate::enclose_var! {
$($tt)+
}
)?
};
// end
[
// clone
// (a => mut b: usize)
// (a => mut b)
$a: expr => mut $b: ident $(: $ty:ty)?
$(, $($tt:tt)+ )?
] => {
let mut $b $(: $ty)? = $a.clone();
$(
$crate::enclose_var! {
$($tt)+
}
)?
};
[
// clone
// (a => b: usize)
// (b => b)
$a: expr => $b: ident $(: $ty:ty)?
$(, $($tt:tt)+ )?
] => {
let $b $(: $ty)? = $a.clone();
$(
$crate::enclose_var! {
$($tt)+
}
)?
};
// end
[
// copy
// (mut *a: String)
// (mut *a)
mut *$a: ident $(: $ty:ty)?
$(, $($tt:tt)+)?
] => {
let mut $a $(: $ty)? = *$a;
$(
$crate::enclose_var! {
$($tt)+
}
)?
};
[
// copy
// (*a: String)
// (*a)
*$a: ident $(: $ty:ty)?
$(, $($tt:tt)+)?
] => {
let $a $(: $ty)? = *$a;
$(
$crate::enclose_var! {
$($tt)+
}
)?
};
// end copy
[
// clone
// (mut a: String)
// (mut a)
mut $a: ident $(: $ty:ty)?
$(, $($tt:tt)+)?
] => {
let mut $a $(: $ty)? = $a.clone();
$(
$crate::enclose_var! {
$($tt)+
}
)?
};
[
// clone
// (a: String)
// (a)
$a: ident $(: $ty:ty)?
$(, $($tt:tt)+)?
] => {
let $a $(: $ty)? = $a.clone();
$(
$crate::enclose_var! {
$($tt)+
}
)?
};
// end clone
[
// run_block
// { panic!("12"); }
{$($b:tt)*}
$(, $($tt:tt)+)?
] => {
let _hidden = {$($b)*};
$( $crate::enclose_var! {
$($tt)+
})?
};
// end block
/*[ $($unk:tt)+ ] => {
compile_error!("Undefined entry or unsupported arguments, please double-check the input.")
};*/
[ $(,)? ] => {};
}
enclose-1.2.0/tests/count_operations.rs 0000644 0000000 0000000 00000002324 10461020230 0016360 0 ustar 0000000 0000000 use core::sync::atomic::AtomicU8;
use core::sync::atomic::Ordering;
use enclose::enc;
#[test]
fn clone_count_operations() {
static CHECK_COUNT_OPERATIONS: AtomicU8 = AtomicU8::new(0);
struct CleverType;
impl Clone for CleverType {
#[inline]
fn clone(&self) -> Self {
let _del = CHECK_COUNT_OPERATIONS.fetch_add(1, Ordering::SeqCst);
CleverType
}
}
let data = CleverType;
assert_eq!(CHECK_COUNT_OPERATIONS.load(Ordering::SeqCst), 0); //Checking the number of operations
enc!((data => d) || {
assert_eq!(CHECK_COUNT_OPERATIONS.load(Ordering::SeqCst), 1); //Checking the number of operations
std::thread::spawn(enc!((d) move || {
assert_eq!(CHECK_COUNT_OPERATIONS.load(Ordering::SeqCst), 2); //Checking the number of operations
enc!((d) || {
enc!((d => _d, d => _d2) move || { //'Move 'is not mandatory here, but since the semantics of the macro are different, we will leave it here for tests.
})();
})();
assert_eq!(CHECK_COUNT_OPERATIONS.load(Ordering::SeqCst), 5); //Checking the number of operations
})).join().unwrap();
})();
let _manclone = data.clone();
//Checking the number of operations,
//Closure = 2
assert_eq!(CHECK_COUNT_OPERATIONS.load(Ordering::SeqCst), 6);
}
enclose-1.2.0/tests/enc.rs 0000644 0000000 0000000 00000006253 10461020230 0013537 0 ustar 0000000 0000000 use enclose::enc;
use enclose::enclose;
use std::sync::Arc;
use std::sync::Mutex;
use std::sync::MutexGuard;
use std::sync::RwLock;
use std::thread;
struct MutexSafeData(Mutex);
impl MutexSafeData {
#[inline]
pub fn new(def: usize) -> Self {
MutexSafeData(Mutex::new(def))
}
#[allow(dead_code)]
#[inline]
pub fn set(&self, size: usize) {
*self.get_mut() = size;
}
#[allow(dead_code)]
#[inline]
pub fn add(&self, size: usize) {
*self.get_mut() += size;
}
#[inline]
pub fn get_mut(&self) -> MutexGuard {
match self.0.lock() {
Ok(a) => a,
Err(e) => e.into_inner(),
}
}
}
#[test]
fn clone_enc_macros() {
let mutex_data = Arc::new(MutexSafeData::new(0));
let mutex_data2 = Arc::new(MutexSafeData::new(0));
// one value
enc!(
(mutex_data) || {
mutex_data.add(1);
}
)();
// two value
enc!(
(mutex_data, mutex_data2) || {
mutex_data.add(1);
mutex_data2.add(1);
}
)();
// one alias
enc!((mutex_data => m1) || {
m1.add(1);
})();
// two alias
enc!((mutex_data => m1, mutex_data2 => m2) || {
m1.add(1);
m2.add(1);
})();
// combination
enc!((mutex_data, mutex_data2 => m2) || {
mutex_data.add(1);
m2.add(1);
})();
assert_eq!(*mutex_data.get_mut(), 5);
assert_eq!(*mutex_data2.get_mut(), 3);
}
#[test]
fn test_unk_operations() {
let mutex_data = Arc::new(MutexSafeData::new(0));
let mutex_data2 = Arc::new(MutexSafeData::new(0));
// one
enc!((@mutex_data.clone() => m1) || {
m1.add(1);
})();
// two
enc!((@mutex_data.clone() => m1, @mutex_data2.clone() => m2) || {
m1.add(1);
m2.add(1);
})();
// unk operations
enc!((@{ mutex_data2.set(1); mutex_data2.clone() } => m2) || {
m2.add(1);
})();
assert_eq!(*mutex_data.get_mut(), 2);
assert_eq!(*mutex_data2.get_mut(), 2);
}
#[test]
fn threadpool_twovalue_and_alias() {
let v1 = Arc::new(MutexSafeData::new(1));
assert_eq!(*v1.get_mut(), 1);
let v2 = Arc::new(RwLock::new((0, 2, 3, 4)));
let count_thread = 5;
let mut join_all = Vec::with_capacity(count_thread);
for _a in 0..count_thread {
join_all.push({
thread::spawn(enclose!((v1, v2, count_thread => alias_cthreads) move || {
assert_eq!(alias_cthreads, 5);
*v1.get_mut() += 1;
let mut lock_v2 = match v2.write() {
Ok(a) => a,
Err(e) => e.into_inner(),
};
lock_v2.0 += 1;
}))
});
}
for a in join_all {
a.join().unwrap();
}
assert_eq!(*v1.get_mut(), 6);
{
let lock_v2 = match v2.write() {
Ok(a) => a,
Err(e) => e.into_inner(),
};
assert_eq!(lock_v2.0, 5);
}
}
#[test]
fn selfalias() {
#[derive(Debug, Clone, PartialEq, PartialOrd)]
struct CheckData {
a: u32,
}
impl CheckData {
#[inline]
pub const fn new(a: u32) -> Self {
Self { a }
}
pub fn calculate(&self, mul_num: &u32) -> u32 {
enc!((*mul_num, self.a => mut num0) move || {
// (*mul_num, self.a => mut num0) ->
// let mul_num = *mul_num;
// let num0 = self.a.clone();
num0 *= mul_num;
num0 += 1024;
num0
})()
// run_enclose
//
// let mut enclose = $crate::enclose!( $($tt)* );
// enclose()
}
}
let data = CheckData::new(1024);
// (data.a * 2) + 1024
assert_eq!(data.calculate(&2), 3072);
// check data
assert_eq!(data.a, 1024);
}
[](https://github.com/clucompany/enclose/actions/workflows/CI.yml)