Compare commits

...

5 commits

Author SHA1 Message Date
Callum Leslie
4cd5c65ea5
chore: release v0.0.3 2025-10-14 09:18:04 +01:00
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
7 changed files with 81 additions and 26 deletions

View file

@ -6,6 +6,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased] ## [Unreleased]
## [0.0.3] - 2025-10-14
### 🚀 Features
- Remove closed flag from ChannelState
- Add internal constructor for `Sucker`/`Sourcer`
### 🐛 Bug Fixes
- Correct toolchain in flake
## [0.0.2] - 2025-09-04 ## [0.0.2] - 2025-09-04
### 🚀 Features ### 🚀 Features

View file

@ -2,7 +2,7 @@
name = "suck" name = "suck"
description = "Suck data up through a channel" description = "Suck data up through a channel"
authors = ["Callum Leslie <git@cleslie.uk>"] authors = ["Callum Leslie <git@cleslie.uk>"]
version = "0.0.2" version = "0.0.3"
edition = "2024" edition = "2024"
documentation = "https://docs.rs/suck" documentation = "https://docs.rs/suck"
homepage = "https://github.com/callumio/suck" homepage = "https://github.com/callumio/suck"
@ -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

@ -1,4 +1,5 @@
use std::sync::atomic::{AtomicBool, Ordering}; use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::{Arc, Mutex};
use crate::error::Error; use crate::error::Error;
use crate::sync::traits::{ChannelReceiver, ChannelSender}; use crate::sync::traits::{ChannelReceiver, ChannelSender};
@ -62,31 +63,47 @@ where
impl<T, SR, ST> Sourcer<T, SR, ST> impl<T, SR, ST> Sourcer<T, SR, ST>
where where
T: Clone + Send + 'static, 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
*state = ValueSource::Static(value); T: Clone,
{
self.state.swap(Arc::new(ValueSource::Static {
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
*state = ValueSource::Dynamic(Box::new(closure)); .swap(Arc::new(ValueSource::Dynamic(Box::new(closure))));
Ok(())
}
/// 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 = ValueSource::Cleared;
Ok(()) Ok(())
} }
@ -103,8 +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 = ValueSource::Cleared;
break; break;
} }
Err(_) => { Err(_) => {
@ -117,12 +133,26 @@ 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();
match &*state { match &**state {
ValueSource::Static(value) => Ok(Response::Value(value.clone())), ValueSource::Static { val, clone } => {
let value = self.execute_closure_safely(&mut || clone(val));
match value {
Ok(v) => Ok(Response::Value(v)),
Err(_) => Ok(Response::NoSource), // Closure execution failed
}
}
ValueSource::Dynamic(closure) => { ValueSource::Dynamic(closure) => {
let value = self.execute_closure_safely(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 { 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
@ -135,7 +165,7 @@ where
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))
} }

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,10 +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::ValueSource::None)); let state = ArcSwap::new(Arc::new(crate::types::ValueSource::None));
let sucker = crate::Sucker::new(request_tx, response_rx); let sucker = crate::Sucker::new(request_tx, response_rx);
let sourcer = crate::Sourcer::new(request_rx, response_tx, std::sync::Arc::clone(&state)); let sourcer = crate::Sourcer::new(request_rx, response_tx, state);
(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,10 +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::ValueSource::None)); let state = Arc::new(crate::types::ValueSource::None);
let state = ArcSwap::new(state);
let sucker = crate::Sucker::new(request_tx, response_rx); let sucker = crate::Sucker::new(request_tx, response_rx);
let sourcer = crate::Sourcer::new(request_rx, response_tx, std::sync::Arc::clone(&state)); let sourcer = crate::Sourcer::new(request_rx, response_tx, state);
(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,10 +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::ValueSource::None)); let state = Arc::new(crate::types::ValueSource::None);
let state = ArcSwap::new(state);
let sucker = crate::Sucker::new(request_tx, response_rx); let sucker = crate::Sucker::new(request_tx, response_rx);
let sourcer = crate::Sourcer::new(request_rx, response_tx, std::sync::Arc::clone(&state)); let sourcer = crate::Sourcer::new(request_rx, response_tx, state);
(sucker, sourcer) (sucker, sourcer)
} }

View file

@ -1,4 +1,6 @@
use std::sync::{Arc, Mutex}; 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 {
@ -15,11 +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, // Never set None, // Never set
Cleared, // Was set but cleared (closed) Cleared, // Was set but cleared (closed)
} }
/// Internal channel state shared between producer and consumer /// Internal channel state shared between producer and consumer
pub(crate) type ChannelState<T> = Arc<Mutex<ValueSource<T>>>; pub(crate) type ChannelState<T> = ArcSwap<ValueSource<T>>;