Compare commits

..

8 commits
v0.0.2 ... main

Author SHA1 Message Date
Roman Moisieiev
4c13facc96 Relax T: Clone bound to only apply to static values
Some checks failed
CI / Run tests (push) Has been cancelled
CI / Lint (push) Has been cancelled
Release-plz / Release-plz release (push) Has been cancelled
Release-plz / Release-plz PR (push) Has been cancelled
2025-10-14 09:17:40 +01:00
Roman Moisieiev
7c8fc42f27 Use separate .set and .set_mut methods 2025-10-14 09:17:40 +01:00
CordlessCoder
016fe5302d Allow for completely lock-free access to Static values, and closed channels. 2025-10-14 09:17:40 +01:00
CordlessCoder
bb5950cd76 Relax dynamic source requirement from Fn to FnMut 2025-10-14 09:17:40 +01:00
4dd7df50e1
feat: add internal constructor for Sucker/Sourcer 2025-09-16 08:26:35 +01:00
ca4825552f
feat: remove closed flag from ChannelState 2025-09-15 11:38:00 +01:00
32b7aa65e6
fix: correct toolchain in flake 2025-09-15 10:10:08 +01:00
Roman Moisieiev
68369a7e4b Remove unnecessary Mutex 2025-09-15 10:09:59 +01:00
7 changed files with 130 additions and 99 deletions

View file

@ -17,6 +17,7 @@ exclude = ["flake.nix", "flake.lock", ".envrc", "cliff.toml", "release-plz.toml"
thiserror = "2.0" thiserror = "2.0"
flume = { version = "0.11", optional = true } flume = { version = "0.11", optional = true }
crossbeam-channel = { version = "0.5", optional = true } crossbeam-channel = { version = "0.5", optional = true }
arc-swap = "1.7.1"
[features] [features]
default = ["all"] default = ["all"]

View file

@ -20,11 +20,17 @@
flake-utils.lib.eachDefaultSystem (system: let flake-utils.lib.eachDefaultSystem (system: let
overlays = [(import rust-overlay)]; overlays = [(import rust-overlay)];
pkgs = import nixpkgs {inherit system overlays;}; pkgs = import nixpkgs {inherit system overlays;};
rustToolchain = pkgs.pkgsBuildHost.rust-bin.stable.latest.default; rustToolchain = pkgs.pkgsBuildHost.rust-bin.fromRustupToolchainFile ./rust-toolchain.toml;
rustToolchainNightly = pkgs.pkgsBuildHost.rust-bin.nightly.latest.default;
tools = with pkgs; [cargo-nextest]; tools = with pkgs; [cargo-nextest];
nativeBuildInputs = with pkgs; [rustToolchain pkg-config] ++ tools; nativeBuildInputs = with pkgs; [rustToolchain rustToolchainNightly pkg-config] ++ tools;
in in
with pkgs; { with pkgs; {
devShells.default = mkShell {inherit nativeBuildInputs;}; devShells.default = mkShell {
inherit nativeBuildInputs;
shellHook = ''
export CARGO_NIGHTLY="${rustToolchainNightly}/bin/cargo"
'';
};
}); });
} }

View file

@ -1,3 +1,4 @@
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::{Arc, Mutex}; use std::sync::{Arc, Mutex};
use crate::error::Error; use crate::error::Error;
@ -10,10 +11,26 @@ where
ST: ChannelSender<Request>, ST: ChannelSender<Request>,
SR: ChannelReceiver<Response<T>>, SR: ChannelReceiver<Response<T>>,
{ {
pub(crate) request_tx: ST, request_tx: ST,
pub(crate) response_rx: SR, response_rx: SR,
pub(crate) closed: Mutex<bool>, closed: AtomicBool,
pub(crate) _phantom: std::marker::PhantomData<T>, _phantom: std::marker::PhantomData<T>,
}
impl<T, ST, SR> Sucker<T, ST, SR>
where
ST: ChannelSender<Request>,
SR: ChannelReceiver<Response<T>>,
{
/// Create a new Sucker instance
pub(crate) fn new(request_tx: ST, response_rx: SR) -> Self {
Self {
request_tx,
response_rx,
closed: AtomicBool::new(false),
_phantom: std::marker::PhantomData,
}
}
} }
/// The producer side of the channel that provides values /// The producer side of the channel that provides values
@ -22,46 +39,71 @@ where
SR: ChannelReceiver<Request>, SR: ChannelReceiver<Request>,
ST: ChannelSender<Response<T>>, ST: ChannelSender<Response<T>>,
{ {
pub(crate) request_rx: SR, request_rx: SR,
pub(crate) response_tx: ST, response_tx: ST,
pub(crate) state: Arc<Mutex<ChannelState<T>>>, state: ChannelState<T>,
pub(crate) _phantom: std::marker::PhantomData<T>, _phantom: std::marker::PhantomData<T>,
} }
impl<T, SR, ST> Sourcer<T, SR, ST> impl<T, SR, ST> Sourcer<T, SR, ST>
where where
T: Clone + Send + 'static, SR: ChannelReceiver<Request>,
ST: ChannelSender<Response<T>>,
{
/// Create a new Sourcer instance
pub(crate) fn new(request_rx: SR, response_tx: ST, state: ChannelState<T>) -> Self {
Self {
request_rx,
response_tx,
state,
_phantom: std::marker::PhantomData,
}
}
}
impl<T, SR, ST> Sourcer<T, SR, ST>
where
T: Send + 'static,
SR: ChannelReceiver<Request>, SR: ChannelReceiver<Request>,
ST: ChannelSender<Response<T>>, ST: ChannelSender<Response<T>>,
{ {
/// Set a fixed value /// Set a fixed value
pub fn set_static(&self, value: T) -> Result<(), Error> { pub fn set_static(&self, val: T) -> Result<(), Error>
let mut state = self.state.lock().map_err(|_| Error::InternalError)?; where
if state.closed { T: Clone,
return Err(Error::ChannelClosed); {
} self.state.swap(Arc::new(ValueSource::Static {
state.source = ValueSource::Static(value); val,
clone: T::clone,
}));
Ok(()) Ok(())
} }
/// Set a closure /// Set a closure that implements [Fn]
pub fn set<F>(&self, closure: F) -> Result<(), Error> pub fn set<F>(&self, closure: F) -> Result<(), Error>
where where
F: Fn() -> T + Send + Sync + 'static, F: Fn() -> T + Send + Sync + 'static,
{ {
let mut state = self.state.lock().map_err(|_| Error::InternalError)?; self.state
if state.closed { .swap(Arc::new(ValueSource::Dynamic(Box::new(closure))));
return Err(Error::ChannelClosed); Ok(())
} }
state.source = ValueSource::Dynamic(Box::new(closure));
/// Set a closure that implements [FnMut]
pub fn set_mut<F>(&self, closure: F) -> Result<(), Error>
where
F: FnMut() -> T + Send + Sync + 'static,
{
self.state
.swap(Arc::new(ValueSource::DynamicMut(Mutex::new(Box::new(
closure,
)))));
Ok(()) Ok(())
} }
/// Close the channel /// Close the channel
pub fn close(&self) -> Result<(), Error> { pub fn close(&self) -> Result<(), Error> {
let mut state = self.state.lock().map_err(|_| Error::InternalError)?; self.state.swap(Arc::new(ValueSource::Cleared));
state.closed = true;
state.source = ValueSource::None;
Ok(()) Ok(())
} }
@ -78,9 +120,7 @@ where
} }
Ok(Request::Close) => { Ok(Request::Close) => {
// Close channel // Close channel
let mut state = self.state.lock().map_err(|_| Error::InternalError)?; self.close()?;
state.closed = true;
state.source = ValueSource::None;
break; break;
} }
Err(_) => { Err(_) => {
@ -93,27 +133,39 @@ where
} }
fn handle_get_value(&self) -> Result<Response<T>, Error> { fn handle_get_value(&self) -> Result<Response<T>, Error> {
let state = self.state.lock().map_err(|_| Error::InternalError)?; let state = self.state.load();
if state.closed {
return Ok(Response::Closed);
}
match &state.source { match &**state {
ValueSource::Static(value) => Ok(Response::Value(value.clone())), ValueSource::Static { val, clone } => {
ValueSource::Dynamic(closure) => { let value = self.execute_closure_safely(&mut || clone(val));
let value = self.execute_closure_safely(closure);
match value { match value {
Ok(v) => Ok(Response::Value(v)), Ok(v) => Ok(Response::Value(v)),
Err(_) => Ok(Response::NoSource), // Closure execution failed Err(_) => Ok(Response::NoSource), // Closure execution failed
} }
} }
ValueSource::None => Ok(Response::NoSource), ValueSource::Dynamic(closure) => {
let value = self.execute_closure_safely(&mut || closure());
match value {
Ok(v) => Ok(Response::Value(v)),
Err(_) => Ok(Response::NoSource), // Closure execution failed
}
}
ValueSource::DynamicMut(closure) => {
let mut closure = closure.lock().unwrap();
let value = self.execute_closure_safely(&mut *closure);
match value {
Ok(v) => Ok(Response::Value(v)),
Err(_) => Ok(Response::NoSource), // Closure execution failed
}
}
ValueSource::None => Ok(Response::NoSource), // No source was ever set
ValueSource::Cleared => Ok(Response::Closed), // Channel was closed (source was set then cleared)
} }
} }
fn execute_closure_safely( fn execute_closure_safely(
&self, &self,
closure: &dyn Fn() -> T, closure: &mut dyn FnMut() -> T,
) -> Result<T, Box<dyn std::any::Any + Send>> { ) -> Result<T, Box<dyn std::any::Any + Send>> {
std::panic::catch_unwind(std::panic::AssertUnwindSafe(closure)) std::panic::catch_unwind(std::panic::AssertUnwindSafe(closure))
} }
@ -127,7 +179,7 @@ where
/// Get the current value from the producer /// Get the current value from the producer
pub fn get(&self) -> Result<T, Error> { pub fn get(&self) -> Result<T, Error> {
// Check if locally marked as closed // Check if locally marked as closed
if *self.closed.lock().unwrap() { if self.closed.load(Ordering::Acquire) {
return Err(Error::ChannelClosed); return Err(Error::ChannelClosed);
} }
@ -152,7 +204,7 @@ where
/// Close the channel from the consumer side /// Close the channel from the consumer side
pub fn close(&self) -> Result<(), Error> { pub fn close(&self) -> Result<(), Error> {
// Mark locally as closed // Mark locally as closed
*self.closed.lock().unwrap() = true; self.closed.store(true, Ordering::Release);
// Send close request // Send close request
self.request_tx self.request_tx

View file

@ -1,6 +1,9 @@
use std::sync::Arc;
#[cfg(feature = "sync-crossbeam")] #[cfg(feature = "sync-crossbeam")]
use crate::sync::traits::{ChannelError, ChannelReceiver, ChannelSender, ChannelType}; use crate::sync::traits::{ChannelError, ChannelReceiver, ChannelSender, ChannelType};
use crate::types; use crate::types;
use arc_swap::ArcSwap;
use crossbeam_channel; use crossbeam_channel;
type CrossbeamSucker<T> = type CrossbeamSucker<T> =
@ -62,24 +65,10 @@ impl<T> CrossbeamSuck<T> {
let (request_tx, request_rx) = CrossbeamChannel::create_request_channel(); let (request_tx, request_rx) = CrossbeamChannel::create_request_channel();
let (response_tx, response_rx) = CrossbeamChannel::create_response_channel::<T>(); let (response_tx, response_rx) = CrossbeamChannel::create_response_channel::<T>();
let state = std::sync::Arc::new(std::sync::Mutex::new(crate::types::ChannelState { let state = ArcSwap::new(Arc::new(crate::types::ValueSource::None));
source: crate::types::ValueSource::None,
closed: false,
}));
let sucker = crate::Sucker { let sucker = crate::Sucker::new(request_tx, response_rx);
request_tx, let sourcer = crate::Sourcer::new(request_rx, response_tx, state);
response_rx,
closed: std::sync::Mutex::new(false),
_phantom: std::marker::PhantomData,
};
let sourcer = crate::Sourcer {
request_rx,
response_tx,
state: std::sync::Arc::clone(&state),
_phantom: std::marker::PhantomData,
};
(sucker, sourcer) (sucker, sourcer)
} }

View file

@ -1,6 +1,9 @@
use std::sync::Arc;
#[cfg(feature = "sync-flume")] #[cfg(feature = "sync-flume")]
use crate::sync::traits::{ChannelError, ChannelReceiver, ChannelSender, ChannelType}; use crate::sync::traits::{ChannelError, ChannelReceiver, ChannelSender, ChannelType};
use crate::types; use crate::types;
use arc_swap::ArcSwap;
use flume; use flume;
type FlumeSucker<T> = type FlumeSucker<T> =
@ -62,24 +65,11 @@ impl<T> FlumeSuck<T> {
let (request_tx, request_rx) = FlumeChannel::create_request_channel(); let (request_tx, request_rx) = FlumeChannel::create_request_channel();
let (response_tx, response_rx) = FlumeChannel::create_response_channel::<T>(); let (response_tx, response_rx) = FlumeChannel::create_response_channel::<T>();
let state = std::sync::Arc::new(std::sync::Mutex::new(crate::types::ChannelState { let state = Arc::new(crate::types::ValueSource::None);
source: crate::types::ValueSource::None, let state = ArcSwap::new(state);
closed: false,
}));
let sucker = crate::Sucker { let sucker = crate::Sucker::new(request_tx, response_rx);
request_tx, let sourcer = crate::Sourcer::new(request_rx, response_tx, state);
response_rx,
closed: std::sync::Mutex::new(false),
_phantom: std::marker::PhantomData,
};
let sourcer = crate::Sourcer {
request_rx,
response_tx,
state: std::sync::Arc::clone(&state),
_phantom: std::marker::PhantomData,
};
(sucker, sourcer) (sucker, sourcer)
} }

View file

@ -1,5 +1,8 @@
use arc_swap::ArcSwap;
use crate::sync::traits::{ChannelError, ChannelReceiver, ChannelSender, ChannelType}; use crate::sync::traits::{ChannelError, ChannelReceiver, ChannelSender, ChannelType};
use crate::types; use crate::types;
use std::sync::Arc;
#[cfg(feature = "sync-std")] #[cfg(feature = "sync-std")]
use std::sync::mpsc; use std::sync::mpsc;
@ -60,24 +63,11 @@ impl<T> StdSuck<T> {
let (request_tx, request_rx) = StdChannel::create_request_channel(); let (request_tx, request_rx) = StdChannel::create_request_channel();
let (response_tx, response_rx) = StdChannel::create_response_channel::<T>(); let (response_tx, response_rx) = StdChannel::create_response_channel::<T>();
let state = std::sync::Arc::new(std::sync::Mutex::new(crate::types::ChannelState { let state = Arc::new(crate::types::ValueSource::None);
source: crate::types::ValueSource::None, let state = ArcSwap::new(state);
closed: false,
}));
let sucker = crate::Sucker { let sucker = crate::Sucker::new(request_tx, response_rx);
request_tx, let sourcer = crate::Sourcer::new(request_rx, response_tx, state);
response_rx,
closed: std::sync::Mutex::new(false),
_phantom: std::marker::PhantomData,
};
let sourcer = crate::Sourcer {
request_rx,
response_tx,
state: std::sync::Arc::clone(&state),
_phantom: std::marker::PhantomData,
};
(sucker, sourcer) (sucker, sourcer)
} }

View file

@ -1,3 +1,7 @@
use std::sync::Mutex;
use arc_swap::ArcSwap;
/// Request messages sent from consumer to producer /// Request messages sent from consumer to producer
pub enum Request { pub enum Request {
GetValue, GetValue,
@ -13,13 +17,12 @@ pub enum Response<T> {
/// Represents the source of values: either static or dynamic /// Represents the source of values: either static or dynamic
pub(crate) enum ValueSource<T> { pub(crate) enum ValueSource<T> {
Static(T), Static { val: T, clone: fn(&T) -> T },
DynamicMut(Mutex<Box<dyn FnMut() -> T + Send + Sync + 'static>>),
Dynamic(Box<dyn Fn() -> T + Send + Sync + 'static>), Dynamic(Box<dyn Fn() -> T + Send + Sync + 'static>),
None, None, // Never set
Cleared, // Was set but cleared (closed)
} }
/// Internal channel state shared between producer and consumer /// Internal channel state shared between producer and consumer
pub(crate) struct ChannelState<T> { pub(crate) type ChannelState<T> = ArcSwap<ValueSource<T>>;
pub(crate) source: ValueSource<T>,
pub(crate) closed: bool,
}