From 3d9b502c7af1f1dab92ee4a3aa07dc667a3bf103 Mon Sep 17 00:00:00 2001
From: Oliver Rockstedt <info@sourcebox.de>
Date: Sat, 18 May 2024 13:37:51 +0200
Subject: [PATCH] embassy-sync: Add capacity and free_capacity functions to
Channel
---
embassy-sync/CHANGELOG.md | 2 +-
embassy-sync/src/channel.rs | 12 ++++++++++++
2 files changed, 13 insertions(+), 1 deletion(-)
diff --git a/embassy-sync/CHANGELOG.md b/embassy-sync/CHANGELOG.md
index 3f6b39d8b..46466d610 100644
--- a/embassy-sync/CHANGELOG.md
+++ b/embassy-sync/CHANGELOG.md
@@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## Unreleased
-- Add `len`, `is_empty` and `is_full` functions to `Channel`.
+- Add `capacity`, `free_capacity`, `len`, `is_empty` and `is_full` functions to `Channel`.
## 0.5.0 - 2023-12-04
diff --git a/embassy-sync/src/channel.rs b/embassy-sync/src/channel.rs
index c4267064c..f9f71d026 100644
--- a/embassy-sync/src/channel.rs
+++ b/embassy-sync/src/channel.rs
@@ -620,6 +620,18 @@ where
self.lock(|c| c.try_receive())
}
+ /// Returns the maximum number of elements the channel can hold.
+ pub const fn capacity(&self) -> usize {
+ N
+ }
+
+ /// Returns the free capacity of the channel.
+ ///
+ /// This is equivalent to `capacity() - len()`
+ pub fn free_capacity(&self) -> usize {
+ N - self.len()
+ }
+
/// Returns the number of elements currently in the channel.
pub fn len(&self) -> usize {
self.lock(|c| c.len())