throttle_my_fn: A Rust attribute macro to throttle the execution of functions
throttle_my_fn is a Rust attribute macro to limit a function's number of runs over a specified period of time, even when called from multiple threads.
The primary use-case for this attribute macro is rate-limiting, e.g. to avoid hammering an online service or to avoid serving too many requests over a period of time.
The macro works by rewriting the function and prefixing it with the necessary book-keeping for throttling (see Usage below). The resulting function is thread-safe.
Usage
Add the dependency to your Cargo.toml:
[dependencies]
throttle_my_fn = "0.2"
Or, using cargo add:
$ cargo add throttle_my_fn
Include the macro:
use throttle_my_fn::throttle;
Annotate the functions you want to throttle:
#[throttle(10, Duration::from_secs(1))]
pub(crate) fn run_10_times_per_second(arg: &str) -> String {
...
}
#[throttle(1, Duration::from_millis(100))]
pub(crate) fn run_once_per_100_milliseconds(arg: &str) -> String {
...
}
Note that the function signatures are modified to wrap the return type in an Option, like so:
pub(crate) fn run_10_times_per_second(arg: &str) -> Option<String> {
...
}
pub(crate) fn run_once_per_100_milliseconds(arg: &str) -> Option<String> {
...
}
The Option
returned signifies whether the function executed or not.
Changelog
-
0.2.3
- Add this Changelog section to the README.
-
0.2.2
- Documentation updates regarding thread-safety.
-
0.2.1
- Documentation update about possible use cases for this crate.
- Thanks go to
@not-matthiasfrom the Rust Linz Discord server for feedback.
-
0.2.0
- Replace the use of
MaybeUninitandAtomicBoolwithparking_lot::Mutexandparking_lot::const_mutex. - Thanks go to
@mejrsand@veber-alexfrom the Rust Discord server for feedback.
- Replace the use of
-
0.1.0
- Initial release
1.2k Dec 31, 2022
26 Oct 17, 2022
4.1k Jan 1, 2023
547 Dec 28, 2022
2.3k Jan 1, 2023
16 Jun 21, 2022
2.3k Jan 3, 2023
403 Dec 25, 2022
351 Dec 29, 2022
5 Nov 16, 2023
354 Jan 1, 2023
89 Dec 23, 2022
354 Jan 6, 2023
139 Dec 30, 2022
0 Dec 25, 2021
0 Sep 2, 2021
12 Jan 14, 2023
2.2k Jan 2, 2023