feat: add display UI with splash screen, dashboard, and RSSI sparkline

Implement full SSD1306 OLED display support:
- Splash screen on boot (1.5s) with project name, version, board
- Dashboard showing radio state, config, counters, RSSI/SNR
- RSSI history sparkline (64-sample ring buffer, 2px-wide bars)
- DisplayOn/DisplayOff host commands routed via dedicated channel
- Pure render functions against generic DrawTarget (no hardware coupling)
- Display on/off control bypasses radio task entirely

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
swaitsandClaude Opus 4.6 committed 2026-03-29 20:42:54 -06:00
1 parent 7064110293
commit 3102fc747a
17624 files changed
+4564928 -38

No files matched your search

+1
View File
@@ -0,0 +1 @@
{"files":{".cargo_vcs_info.json":"57266bd9c8f86f8f8b5dfdfc6de4721e0c441fc546405a34df9851c6aab9bf26",".github/CODEOWNERS":"4c941d2793c0360c653073d3532cf1ec80d34133ecc877525b62245fc6c3f340",".github/bors.toml":"6bb84926537bf827cd53db7fb60d2b5fa09b81c2e80e3c7de59442fbbeb0999f",".travis.yml":"e6e6ea28b105d40fe6ce22a105cbca5a8728e6a095321927b7205645cde05755","CHANGELOG.md":"989eaab000aebf7b56fe1e3d158cfd480d82931d9a27f72cbb498bb329c304d4","CODE_OF_CONDUCT.md":"3746a267d008534cec6d7242f09ca6284c5d37e48306531b878461e6c4d33fee","Cargo.toml":"0f59595b6a2e6f034e8211877fd7f1185c204dc48b39d0475a2568ddd1c45286","Cargo.toml.orig":"0a70326e2a6040b1236facf8fc875c4f658afff297e0c4fbcc85d05a076a3518","LICENSE-APACHE":"a60eea817514531668d7e00765731449fe14d059d3249e0bc93b36de45f759f2","LICENSE-MIT":"0a633406531735659d570e7903394ec52f7707195a3c4af10279f06eec7acc76","README.md":"988c012445d6b29cf91baf16ca85aaf7f5f9d270d98a09987cea4b1e0e48ebf5","ci/install.sh":"818cf567e442d1afba6e446692c24de8b9005835970ab3c6e65744bb7715f9f4","ci/script.sh":"f9aab63e656731a6bbc3752654fe76f385e9178abb4b15c96461e635be288582","src/lib.rs":"eef466e78b9a4c678621ba06932096601d5d68c73dc1087a700666ccb6825616"},"package":"b4bb1638d419e12f8b1c43d9e639abd0d1424285bdea2f76aa231e233c63cd3a"}
+5
View File
@@ -0,0 +1,5 @@
{
"git": {
"sha1": "753b9e71c4527e3f7b193e6c66711b2509ad37a2"
}
}
+1
View File
@@ -0,0 +1 @@
* @rust-embedded/cortex-m
+4
View File
@@ -0,0 +1,4 @@
block_labels = ["needs-decision"]
delete_merged_branches = true
required_approvals = 1
status = ["continuous-integration/travis-ci/push"]
+68
View File
@@ -0,0 +1,68 @@
language: rust
matrix:
include:
- env: TARGET=x86_64-unknown-linux-gnu
rust: stable
if: (branch = staging OR branch = trying) OR (type = pull_request AND branch = master)
- env: TARGET=thumbv6m-none-eabi
rust: stable
if: (branch = staging OR branch = trying) OR (type = pull_request AND branch = master)
- env: TARGET=thumbv7m-none-eabi
rust: stable
if: (branch = staging OR branch = trying) OR (type = pull_request AND branch = master)
- env: TARGET=thumbv7em-none-eabi
rust: stable
if: (branch = staging OR branch = trying) OR (type = pull_request AND branch = master)
- env: TARGET=thumbv7em-none-eabihf
rust: stable
if: (branch = staging OR branch = trying) OR (type = pull_request AND branch = master)
# MSRV
- env: TARGET=thumbv6m-none-eabi
rust: 1.31.0
if: (branch = staging OR branch = trying) OR (type = pull_request AND branch = master)
# MSRV
- env: TARGET=thumbv7m-none-eabi
rust: 1.31.0
if: (branch = staging OR branch = trying) OR (type = pull_request AND branch = master)
# MSRV
- env: TARGET=thumbv7em-none-eabi
rust: 1.31.0
if: (branch = staging OR branch = trying) OR (type = pull_request AND branch = master)
# MSRV
- env: TARGET=thumbv7em-none-eabihf
rust: 1.31.0
if: (branch = staging OR branch = trying) OR (type = pull_request AND branch = master)
before_install: set -e
install:
- bash ci/install.sh
script:
- bash ci/script.sh
after_script: set +e
cache: cargo
before_cache:
- chmod -R a+r $HOME/.cargo;
branches:
only:
- master
- staging
- trying
notifications:
email:
on_success: never
+21
View File
@@ -0,0 +1,21 @@
# Change Log
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).
## [Unreleased]
## [0.2.0]
### Changes
- [breaking-change] `Exclusive` was changed to be a reference wrapper to work with external resources
## [0.1.0]
- First release
[Unreleased]: https://github.com/rust-embedded/mutex-trait/compare/v0.2.0...HEAD
[v0.2.0]: https://github.com/rust-embedded/mutex-trait/compare/v0.1.0...v0.2.0
+37
View File
@@ -0,0 +1,37 @@
# The Rust Code of Conduct
## Conduct
**Contact**: [Cortex-M team](https://github.com/rust-embedded/wg#the-cortex-m-team)
* We are committed to providing a friendly, safe and welcoming environment for all, regardless of level of experience, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, nationality, or other similar characteristic.
* On IRC, please avoid using overtly sexual nicknames or other nicknames that might detract from a friendly, safe and welcoming environment for all.
* Please be kind and courteous. There's no need to be mean or rude.
* Respect that people have differences of opinion and that every design or implementation choice carries a trade-off and numerous costs. There is seldom a right answer.
* Please keep unstructured critique to a minimum. If you have solid ideas you want to experiment with, make a fork and see how it works.
* We will exclude you from interaction if you insult, demean or harass anyone. That is not welcome behavior. We interpret the term "harassment" as including the definition in the [Citizen Code of Conduct](http://citizencodeofconduct.org/); if you have any lack of clarity about what might be included in that concept, please read their definition. In particular, we don't tolerate behavior that excludes people in socially marginalized groups.
* Private harassment is also unacceptable. No matter who you are, if you feel you have been or are being harassed or made uncomfortable by a community member, please contact one of the channel ops or any of the [Cortex-M team][team] immediately. Whether you're a regular contributor or a newcomer, we care about making this community a safe place for you and we've got your back.
* Likewise any spamming, trolling, flaming, baiting or other attention-stealing behavior is not welcome.
## Moderation
These are the policies for upholding our community's standards of conduct.
1. Remarks that violate the Rust standards of conduct, including hateful, hurtful, oppressive, or exclusionary remarks, are not allowed. (Cursing is allowed, but never targeting another user, and never in a hateful manner.)
2. Remarks that moderators find inappropriate, whether listed in the code of conduct or not, are also not allowed.
3. Moderators will first respond to such remarks with a warning.
4. If the warning is unheeded, the user will be "kicked," i.e., kicked out of the communication channel to cool off.
5. If the user comes back and continues to make trouble, they will be banned, i.e., indefinitely excluded.
6. Moderators may choose at their discretion to un-ban the user if it was a first offense and they offer the offended party a genuine apology.
7. If a moderator bans someone and you think it was unjustified, please take it up with that moderator, or with a different moderator, **in private**. Complaints about bans in-channel are not allowed.
8. Moderators are held to a higher standard than other community members. If a moderator creates an inappropriate situation, they should expect less leeway than others.
In the Rust community we strive to go the extra step to look out for each other. Don't just aim to be technically unimpeachable, try to be your best self. In particular, avoid flirting with offensive or sensitive issues, particularly if they're off-topic; this all too often leads to unnecessary fights, hurt feelings, and damaged trust; worse, it can drive people away from the community entirely.
And if someone takes issue with something you said or did, resist the urge to be defensive. Just stop doing what it was they complained about and apologize. Even if you feel you were misinterpreted or unfairly accused, chances are good there was something you could've communicated better — remember that it's your responsibility to make your fellow Rustaceans comfortable. Everyone wants to get along and we are all here first and foremost because we want to talk about cool technology. You will find that people will be eager to assume good intent and forgive as long as you earn their trust.
The enforcement policies listed above apply to all official embedded WG venues; including official IRC channels (#rust-embedded); GitHub repositories under rust-embedded; and all forums under rust-embedded.org (forum.rust-embedded.org).
*Adapted from the [Node.js Policy on Trolling](http://blog.izs.me/post/30036893703/policy-on-trolling) as well as the [Contributor Covenant v1.3.0](https://www.contributor-covenant.org/version/1/3/0/).*
[team]: https://github.com/rust-embedded/wg#the-cortex-m-team
+24
View File
@@ -0,0 +1,24 @@
# 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 believe there's an error in this file please file an
# issue against the rust-lang/cargo repository. If you're
# editing this file be aware that the upstream Cargo.toml
# will likely look very different (and much more reasonable)
[package]
edition = "2018"
name = "mutex-trait"
version = "0.2.0"
authors = ["The Cortex-M Team <cortex-m@teams.rust-embedded.org>"]
description = "Foundational mutex trait and helpers"
documentation = "https://docs.rs/mutex-trait"
readme = "README.md"
keywords = ["mutex"]
categories = ["embedded", "no-std"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/rust-embedded/mutex-trait"
+201
View File
@@ -0,0 +1,201 @@
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 [yyyy] [name of copyright owner]
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.
+25
View File
@@ -0,0 +1,25 @@
Copyright (c) 2016 Jorge Aparicio
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.
+36
View File
@@ -0,0 +1,36 @@
[![crates.io](https://img.shields.io/crates/d/mutex-trait.svg)](https://crates.io/crates/mutex-trait)
[![crates.io](https://img.shields.io/crates/v/mutex-trait.svg)](https://crates.io/crates/mutex-trait)
# `mutex-trait`
> Low level API definition of a Mutex
This project is developed and maintained by the [Resources team][team].
## [Documentation](https://docs.rs/mutex-trait)
## License
Licensed under either of
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the
work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
additional terms or conditions.
## Code of Conduct
Contribution to this crate is organized under the terms of the [Rust Code of
Conduct][CoC], the maintainer of this crate, the [Resources team][team], promises
to intervene to uphold that code of conduct.
[CoC]: CODE_OF_CONDUCT.md
[team]: https://github.com/rust-embedded/wg#the-resources-team
+11
View File
@@ -0,0 +1,11 @@
set -euxo pipefail
main() {
case $TARGET in
thumbv*-none-eabi*)
rustup target add $TARGET
;;
esac
}
main
+29
View File
@@ -0,0 +1,29 @@
set -euxo pipefail
main() {
if [ $TRAVIS_RUST_VERSION = nightly ]; then
export RUSTFLAGS="-D warnings"
fi
cargo check --target $TARGET
case $TARGET in
thumbv*-none-eabi*)
;;
x86_64-unknown-linux-gnu)
cargo test --target $TARGET
;;
esac
if [ $TRAVIS_RUST_VERSION = nightly ]; then
# Get the latest nightly with a working clippy
rustup toolchain uninstall nightly
rustup set profile default
rustup default nightly
rustup target add $TARGET
cargo clippy --target $TARGET -- -D warnings
fi
}
main
+326
View File
@@ -0,0 +1,326 @@
//! Low level definition of a Mutex.
//!
//! This crate provides:
//!
//! - A `Mutex` trait that is to be used as the foundation of exclusive access to the data
//! contained within it.
//! - Helper traits and implementations which allows for multiple locks to be taken at once.
//!
//! RFC that added this trait: [RFC #377](https://github.com/rust-embedded/wg/blob/master/rfcs/0377-mutex-trait.md)
//!
//! # Example
//!
//! ```
//! use mutex_trait::prelude::*;
//!
//! // A function taking 2 mutexes
//! fn normal_lock(
//! a: &mut impl Mutex<Data = i32>,
//! b: &mut impl Mutex<Data = i32>,
//! ) {
//! // Taking each lock separately
//! a.lock(|a| {
//! b.lock(|b| {
//! *a += 1;
//! *b += 1;
//! });
//! });
//!
//! // Or both at once
//! (a, b).lock(|a, b| {
//! *a += 1;
//! *b += 1;
//! });
//! }
//! ```
//!
//! # Minimum Supported Rust Version (MSRV)
//!
//! This crate is guaranteed to compile on stable Rust 1.31 and up. It *might*
//! compile with older versions but that may change in any new patch release.
#![no_std]
#![deny(missing_docs)]
use core::cell::RefCell;
use core::ops::{Deref, DerefMut};
/// Makes locks work on N-tuples, locks the mutexes from left-to-right in the tuple. These are
/// used to reduce rightward drift in code and to help make intentions clearer.
///
/// # Example
///
/// ```
/// use mutex_trait::prelude::*;
///
/// fn normal_lock(
/// a: &mut impl Mutex<Data = i32>,
/// b: &mut impl Mutex<Data = i32>,
/// c: &mut impl Mutex<Data = i32>
/// ) {
/// // A lot of rightward drift...
/// a.lock(|a| {
/// b.lock(|b| {
/// c.lock(|c| {
/// *a += 1;
/// *b += 1;
/// *c += 1;
/// });
/// });
/// });
/// }
/// ```
///
/// Has a shorthand as:
///
/// ```
/// use mutex_trait::prelude::*;
///
/// fn tuple_lock(
/// a: &mut impl Mutex<Data = i32>,
/// b: &mut impl Mutex<Data = i32>,
/// c: &mut impl Mutex<Data = i32>
/// ) {
/// // Look! Single indent and less to write
/// (a, b, c).lock(|a, b, c| {
/// *a += 1;
/// *b += 1;
/// *c += 1;
/// });
/// }
/// ```
pub mod prelude {
pub use crate::Mutex;
macro_rules! lock {
($e:ident, $fun:block) => {
$e.lock(|$e| $fun )
};
($e:ident, $($es:ident),+, $fun:block) => {
$e.lock(|$e| lock!($($es),*, $fun))
};
}
macro_rules! make_tuple_impl {
($name:ident, $($es:ident),+) => {
/// Auto-generated tuple implementation, see [`Mutex`](../trait.Mutex.html) for details.
pub trait $name {
$(
/// Data protected by the mutex.
type $es;
)*
/// Creates a critical section and grants temporary access to the protected data.
fn lock<R>(&mut self, f: impl FnOnce($(&mut Self::$es),*) -> R) -> R;
}
impl<$($es),+> $name for ($($es,)+)
where
$($es: crate::Mutex),*
{
$(
type $es = $es::Data;
)*
#[allow(non_snake_case)]
fn lock<R>(&mut self, f: impl FnOnce($(&mut Self::$es),*) -> R) -> R {
let ($(
$es,
)*) = self;
lock!($($es),*, { f($($es),*) })
}
}
};
}
// Generate tuple lock impls
make_tuple_impl!(TupleExt01, T1);
make_tuple_impl!(TupleExt02, T1, T2);
make_tuple_impl!(TupleExt03, T1, T2, T3);
make_tuple_impl!(TupleExt04, T1, T2, T3, T4);
make_tuple_impl!(TupleExt05, T1, T2, T3, T4, T5);
make_tuple_impl!(TupleExt06, T1, T2, T3, T4, T5, T6);
make_tuple_impl!(TupleExt07, T1, T2, T3, T4, T5, T6, T7);
make_tuple_impl!(TupleExt08, T1, T2, T3, T4, T5, T6, T7, T8);
make_tuple_impl!(TupleExt09, T1, T2, T3, T4, T5, T6, T7, T8, T9);
make_tuple_impl!(TupleExt10, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10);
make_tuple_impl!(TupleExt11, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11);
make_tuple_impl!(TupleExt12, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12);
}
/// Any object implementing this trait guarantees exclusive access to the data contained
/// within the mutex for the duration of the lock.
pub trait Mutex {
/// Data protected by the mutex.
type Data;
/// Creates a critical section and grants temporary access to the protected data.
fn lock<R>(&mut self, f: impl FnOnce(&mut Self::Data) -> R) -> R;
}
// `lock` will now work on any mutable reference to a lock
impl<L> Mutex for &'_ mut L
where
L: Mutex,
{
type Data = L::Data;
fn lock<R>(&mut self, f: impl FnOnce(&mut Self::Data) -> R) -> R {
L::lock(self, f)
}
}
// A RefCell is a lock in single threaded applications
impl<T> Mutex for &'_ RefCell<T> {
type Data = T;
fn lock<R>(&mut self, f: impl FnOnce(&mut T) -> R) -> R {
f(&mut self.borrow_mut())
}
}
/// Wraps a `T` and provides exclusive access via a `Mutex` impl.
///
/// This provides an no-op `Mutex` implementation for data that does not need a real mutex.
#[derive(Debug)]
pub struct Exclusive<'a, T>(&'a mut T);
impl<'a, T> Exclusive<'a, T> {
/// Creates a new `Exclusive` object wrapping `data`.
pub fn new(data: &'a mut T) -> Self {
Exclusive(data)
}
/// Consumes this `Exclusive` instance and returns the wrapped value.
pub fn into_inner(self) -> &'a mut T {
self.0
}
}
impl<'a, T> From<&'a mut T> for Exclusive<'a, T> {
fn from(data: &'a mut T) -> Self {
Exclusive(data)
}
}
impl<'a, T> Deref for Exclusive<'a, T> {
type Target = T;
fn deref(&self) -> &T {
self.0
}
}
impl<'a, T> DerefMut for Exclusive<'a, T> {
fn deref_mut(&mut self) -> &mut T {
self.0
}
}
impl<'a, T> Mutex for Exclusive<'a, T> {
type Data = T;
fn lock<R>(&mut self, f: impl FnOnce(&mut T) -> R) -> R {
f(self.0)
}
}
#[cfg(test)]
#[allow(dead_code)]
mod tests {
use crate::prelude::*;
use crate::Exclusive;
fn compile_test_single_move(mut a: impl Mutex<Data = i32>) {
a.lock(|a| {
*a += 1;
});
}
fn compile_test_single_reference(a: &mut impl Mutex<Data = i32>) {
a.lock(|a| {
*a += 1;
});
}
fn compile_test_double_move(mut a: impl Mutex<Data = i32>, mut b: impl Mutex<Data = i32>) {
a.lock(|a| {
*a += 1;
});
b.lock(|b| {
*b += 1;
});
(a, b).lock(|a, b| {
*a += 1;
*b += 1;
});
}
fn compile_test_double_reference(
a: &mut impl Mutex<Data = i32>,
b: &mut impl Mutex<Data = i32>,
) {
a.lock(|a| {
*a += 1;
});
b.lock(|b| {
*b += 1;
});
(a, b).lock(|a, b| {
*a += 1;
*b += 1;
});
}
fn compile_test_move_and_reference(
mut a: impl Mutex<Data = i32>,
b: &mut impl Mutex<Data = i32>,
) {
a.lock(|a| {
*a += 1;
});
b.lock(|b| {
*b += 1;
});
(a, b).lock(|a, b| {
*a += 1;
*b += 1;
});
}
#[test]
fn refcell_lock() {
let a = core::cell::RefCell::new(0);
let b = core::cell::RefCell::new(0);
(&a).lock(|a| {
*a += 1;
});
(&b).lock(|b| {
*b += 1;
});
(&a, &b).lock(|a, b| {
*a += 1;
*b += 1;
});
}
#[test]
fn exclusive() {
let mut var = 0;
let mut excl = Exclusive(&mut var);
excl.lock(|val| *val += 1);
assert_eq!(*excl.into_inner(), 1);
}
}