mirror of
https://github.com/callumio/suck.git
synced 2025-12-17 11:39:20 +00:00
Compare commits
No commits in common. "main" and "v0.0.1" have entirely different histories.
13 changed files with 223 additions and 830 deletions
2
.github/workflows/ci.yml
vendored
2
.github/workflows/ci.yml
vendored
|
|
@ -26,7 +26,7 @@ jobs:
|
||||||
toolchain: stable
|
toolchain: stable
|
||||||
- uses: Swatinem/rust-cache@v2
|
- uses: Swatinem/rust-cache@v2
|
||||||
- name: Minimal build
|
- name: Minimal build
|
||||||
run: cargo build
|
run: cargo build --no-default-features
|
||||||
- name: Clippy
|
- name: Clippy
|
||||||
run: cargo clippy --all-features --examples -- -D warnings
|
run: cargo clippy --all-features --examples -- -D warnings
|
||||||
- name: Build all
|
- name: Build all
|
||||||
|
|
|
||||||
|
|
@ -6,11 +6,6 @@ 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.2] - 2025-09-04
|
|
||||||
|
|
||||||
### 🚀 Features
|
|
||||||
|
|
||||||
- Add multiple channel providers
|
|
||||||
## [0.0.1] - 2025-09-02
|
## [0.0.1] - 2025-09-02
|
||||||
|
|
||||||
### 🚀 Features
|
### 🚀 Features
|
||||||
|
|
|
||||||
22
Cargo.toml
22
Cargo.toml
|
|
@ -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.1"
|
||||||
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"
|
||||||
|
|
@ -15,25 +15,5 @@ exclude = ["flake.nix", "flake.lock", ".envrc", "cliff.toml", "release-plz.toml"
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
thiserror = "2.0"
|
thiserror = "2.0"
|
||||||
flume = { version = "0.11", optional = true }
|
|
||||||
crossbeam-channel = { version = "0.5", optional = true }
|
|
||||||
arc-swap = "1.7.1"
|
|
||||||
|
|
||||||
[features]
|
|
||||||
default = ["all"]
|
|
||||||
|
|
||||||
sync = []
|
|
||||||
async = []
|
|
||||||
|
|
||||||
sync-std = ["sync"]
|
|
||||||
sync-flume = ["sync", "dep:flume"]
|
|
||||||
sync-crossbeam = ["sync", "dep:crossbeam-channel"]
|
|
||||||
|
|
||||||
all-sync = ["sync-std", "sync-flume", "sync-crossbeam"]
|
|
||||||
|
|
||||||
all = ["all-sync"]
|
|
||||||
|
|
||||||
[lib]
|
[lib]
|
||||||
|
|
||||||
[package.metadata.docs.rs]
|
|
||||||
all-features = true
|
|
||||||
|
|
|
||||||
|
|
@ -32,11 +32,11 @@ suck = "*"
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
```rust
|
```rust
|
||||||
use suck::sync::StdSuck;
|
use suck::SuckPair;
|
||||||
|
|
||||||
fn main() -> Result<(), Box<dyn std::error::Error>> {
|
fn main() -> Result<(), Box<dyn std::error::Error>> {
|
||||||
// Create a pair (using default std backend)
|
// Create a pair
|
||||||
let (sucker, sourcer) = StdSuck::<i32>::pair();
|
let (sucker, sourcer) = SuckPair::<i32>::pair();
|
||||||
|
|
||||||
// Start producer in a thread
|
// Start producer in a thread
|
||||||
let producer = std::thread::spawn(move || {
|
let producer = std::thread::spawn(move || {
|
||||||
|
|
|
||||||
12
flake.nix
12
flake.nix
|
|
@ -20,17 +20,11 @@
|
||||||
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.fromRustupToolchainFile ./rust-toolchain.toml;
|
rustToolchain = pkgs.pkgsBuildHost.rust-bin.stable.latest.default;
|
||||||
rustToolchainNightly = pkgs.pkgsBuildHost.rust-bin.nightly.latest.default;
|
|
||||||
tools = with pkgs; [cargo-nextest];
|
tools = with pkgs; [cargo-nextest];
|
||||||
nativeBuildInputs = with pkgs; [rustToolchain rustToolchainNightly pkg-config] ++ tools;
|
nativeBuildInputs = with pkgs; [rustToolchain pkg-config] ++ tools;
|
||||||
in
|
in
|
||||||
with pkgs; {
|
with pkgs; {
|
||||||
devShells.default = mkShell {
|
devShells.default = mkShell {inherit nativeBuildInputs;};
|
||||||
inherit nativeBuildInputs;
|
|
||||||
shellHook = ''
|
|
||||||
export CARGO_NIGHTLY="${rustToolchainNightly}/bin/cargo"
|
|
||||||
'';
|
|
||||||
};
|
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
|
||||||
173
src/channel.rs
173
src/channel.rs
|
|
@ -1,109 +1,90 @@
|
||||||
use std::sync::atomic::{AtomicBool, Ordering};
|
use std::sync::mpsc;
|
||||||
use std::sync::{Arc, Mutex};
|
use std::sync::{Arc, Mutex};
|
||||||
|
|
||||||
use crate::error::Error;
|
use crate::error::Error;
|
||||||
use crate::sync::traits::{ChannelReceiver, ChannelSender};
|
|
||||||
use crate::types::{ChannelState, Request, Response, ValueSource};
|
use crate::types::{ChannelState, Request, Response, ValueSource};
|
||||||
|
|
||||||
/// The consumer side of the channel that requests values
|
/// The consumer side of the channel that requests values
|
||||||
pub struct Sucker<T, ST, SR>
|
pub struct Sucker<T> {
|
||||||
where
|
request_tx: mpsc::Sender<Request>,
|
||||||
ST: ChannelSender<Request>,
|
response_rx: mpsc::Receiver<Response<T>>,
|
||||||
SR: ChannelReceiver<Response<T>>,
|
closed: Mutex<bool>,
|
||||||
{
|
|
||||||
request_tx: ST,
|
|
||||||
response_rx: SR,
|
|
||||||
closed: AtomicBool,
|
|
||||||
_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
|
||||||
pub struct Sourcer<T, SR, ST>
|
pub struct Sourcer<T> {
|
||||||
where
|
request_rx: mpsc::Receiver<Request>,
|
||||||
SR: ChannelReceiver<Request>,
|
response_tx: mpsc::Sender<Response<T>>,
|
||||||
ST: ChannelSender<Response<T>>,
|
state: Arc<Mutex<ChannelState<T>>>,
|
||||||
{
|
}
|
||||||
request_rx: SR,
|
|
||||||
response_tx: ST,
|
/// Helper type for creating Sucker and Sourcer instances
|
||||||
state: ChannelState<T>,
|
pub struct SuckPair<T> {
|
||||||
_phantom: std::marker::PhantomData<T>,
|
_phantom: std::marker::PhantomData<T>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<T, SR, ST> Sourcer<T, SR, ST>
|
impl<T> SuckPair<T> {
|
||||||
where
|
/// Create a new suck pair
|
||||||
SR: ChannelReceiver<Request>,
|
pub fn pair() -> (Sucker<T>, Sourcer<T>)
|
||||||
ST: ChannelSender<Response<T>>,
|
where
|
||||||
{
|
T: Clone + Send + 'static,
|
||||||
/// Create a new Sourcer instance
|
{
|
||||||
pub(crate) fn new(request_rx: SR, response_tx: ST, state: ChannelState<T>) -> Self {
|
let (request_tx, request_rx) = mpsc::channel();
|
||||||
Self {
|
let (response_tx, response_rx) = mpsc::channel();
|
||||||
|
|
||||||
|
let state = Arc::new(Mutex::new(ChannelState {
|
||||||
|
source: ValueSource::None,
|
||||||
|
closed: false,
|
||||||
|
}));
|
||||||
|
|
||||||
|
let sucker = Sucker {
|
||||||
|
request_tx,
|
||||||
|
response_rx,
|
||||||
|
closed: Mutex::new(false),
|
||||||
|
};
|
||||||
|
|
||||||
|
let sourcer = Sourcer {
|
||||||
request_rx,
|
request_rx,
|
||||||
response_tx,
|
response_tx,
|
||||||
state,
|
state: Arc::clone(&state),
|
||||||
_phantom: std::marker::PhantomData,
|
};
|
||||||
}
|
|
||||||
|
(sucker, sourcer)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<T, SR, ST> Sourcer<T, SR, ST>
|
impl<T> Sourcer<T>
|
||||||
where
|
where
|
||||||
T: Send + 'static,
|
T: Clone + Send + 'static,
|
||||||
SR: ChannelReceiver<Request>,
|
|
||||||
ST: ChannelSender<Response<T>>,
|
|
||||||
{
|
{
|
||||||
/// Set a fixed value
|
/// Set a fixed value
|
||||||
pub fn set_static(&self, val: T) -> Result<(), Error>
|
pub fn set_static(&self, value: T) -> Result<(), Error> {
|
||||||
where
|
let mut state = self.state.lock().map_err(|_| Error::InternalError)?;
|
||||||
T: Clone,
|
if state.closed {
|
||||||
{
|
return Err(Error::ChannelClosed);
|
||||||
self.state.swap(Arc::new(ValueSource::Static {
|
}
|
||||||
val,
|
state.source = ValueSource::Static(value);
|
||||||
clone: T::clone,
|
|
||||||
}));
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Set a closure that implements [Fn]
|
/// Set a closure
|
||||||
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,
|
||||||
{
|
{
|
||||||
self.state
|
let mut state = self.state.lock().map_err(|_| Error::InternalError)?;
|
||||||
.swap(Arc::new(ValueSource::Dynamic(Box::new(closure))));
|
if state.closed {
|
||||||
Ok(())
|
return Err(Error::ChannelClosed);
|
||||||
}
|
}
|
||||||
|
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> {
|
||||||
self.state.swap(Arc::new(ValueSource::Cleared));
|
let mut state = self.state.lock().map_err(|_| Error::InternalError)?;
|
||||||
|
state.closed = true;
|
||||||
|
state.source = ValueSource::None;
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -120,7 +101,9 @@ where
|
||||||
}
|
}
|
||||||
Ok(Request::Close) => {
|
Ok(Request::Close) => {
|
||||||
// Close channel
|
// Close channel
|
||||||
self.close()?;
|
let mut state = self.state.lock().map_err(|_| Error::InternalError)?;
|
||||||
|
state.closed = true;
|
||||||
|
state.source = ValueSource::None;
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
Err(_) => {
|
Err(_) => {
|
||||||
|
|
@ -133,53 +116,37 @@ where
|
||||||
}
|
}
|
||||||
|
|
||||||
fn handle_get_value(&self) -> Result<Response<T>, Error> {
|
fn handle_get_value(&self) -> Result<Response<T>, Error> {
|
||||||
let state = self.state.load();
|
let state = self.state.lock().map_err(|_| Error::InternalError)?;
|
||||||
|
if state.closed {
|
||||||
|
return Ok(Response::Closed);
|
||||||
|
}
|
||||||
|
|
||||||
match &**state {
|
match &state.source {
|
||||||
ValueSource::Static { val, clone } => {
|
ValueSource::Static(value) => Ok(Response::Value(value.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(&mut || closure());
|
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::DynamicMut(closure) => {
|
ValueSource::None => Ok(Response::NoSource),
|
||||||
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: &mut dyn FnMut() -> T,
|
closure: &dyn Fn() -> 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))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<T, ST, SR> Sucker<T, ST, SR>
|
impl<T> Sucker<T> {
|
||||||
where
|
|
||||||
ST: ChannelSender<Request>,
|
|
||||||
SR: ChannelReceiver<Response<T>>,
|
|
||||||
{
|
|
||||||
/// 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.load(Ordering::Acquire) {
|
if *self.closed.lock().unwrap() {
|
||||||
return Err(Error::ChannelClosed);
|
return Err(Error::ChannelClosed);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -204,7 +171,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.store(true, Ordering::Release);
|
*self.closed.lock().unwrap() = true;
|
||||||
|
|
||||||
// Send close request
|
// Send close request
|
||||||
self.request_tx
|
self.request_tx
|
||||||
|
|
|
||||||
143
src/lib.rs
143
src/lib.rs
|
|
@ -1,12 +1,145 @@
|
||||||
#![doc = include_str!("../README.md")]
|
#![doc = include_str!("../README.md")]
|
||||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
|
||||||
|
|
||||||
pub mod channel;
|
pub mod channel;
|
||||||
pub mod error;
|
pub mod error;
|
||||||
|
|
||||||
#[cfg(feature = "sync")]
|
|
||||||
pub mod sync;
|
|
||||||
pub mod types;
|
pub mod types;
|
||||||
|
|
||||||
pub use channel::{Sourcer, Sucker};
|
// Re-exports
|
||||||
|
pub use channel::{Sourcer, SuckPair, Sucker};
|
||||||
pub use error::Error;
|
pub use error::Error;
|
||||||
|
pub use types::ValueSource;
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
use std::thread;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_pre_computed_value() {
|
||||||
|
let (sucker, sourcer) = SuckPair::<i32>::pair();
|
||||||
|
|
||||||
|
// Start producer
|
||||||
|
let producer_handle = thread::spawn(move || {
|
||||||
|
sourcer.set_static(42).unwrap();
|
||||||
|
sourcer.run().unwrap();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Ensure consumer gets the value
|
||||||
|
let value = sucker.get().unwrap();
|
||||||
|
assert_eq!(value, 42);
|
||||||
|
|
||||||
|
// Close consumer
|
||||||
|
sucker.close().unwrap();
|
||||||
|
|
||||||
|
producer_handle.join().unwrap();
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_closure_value() {
|
||||||
|
let (sucker, sourcer) = SuckPair::<i32>::pair();
|
||||||
|
|
||||||
|
// Start producer
|
||||||
|
let producer_handle = std::thread::spawn(move || {
|
||||||
|
let counter = std::sync::Arc::new(std::sync::Mutex::new(0));
|
||||||
|
let counter_clone = std::sync::Arc::clone(&counter);
|
||||||
|
sourcer
|
||||||
|
.set(move || {
|
||||||
|
let mut count = counter_clone.lock().unwrap();
|
||||||
|
*count += 1;
|
||||||
|
*count
|
||||||
|
})
|
||||||
|
.unwrap();
|
||||||
|
sourcer.run().unwrap();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Ensure consumer gets the value
|
||||||
|
let value1 = sucker.get().unwrap();
|
||||||
|
assert_eq!(value1, 1);
|
||||||
|
|
||||||
|
// Ensure consumer gets the next value
|
||||||
|
let value2 = sucker.get().unwrap();
|
||||||
|
assert_eq!(value2, 2);
|
||||||
|
|
||||||
|
// Close consumer
|
||||||
|
sucker.close().unwrap();
|
||||||
|
|
||||||
|
producer_handle.join().unwrap();
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_no_source_error() {
|
||||||
|
let (sucker, sourcer) = SuckPair::<i32>::pair();
|
||||||
|
|
||||||
|
// Start producer
|
||||||
|
let producer_handle = thread::spawn(move || {
|
||||||
|
sourcer.run().unwrap();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Consumer should get NoSource error
|
||||||
|
let result = sucker.get();
|
||||||
|
assert!(matches!(result, Err(Error::NoSource)));
|
||||||
|
|
||||||
|
// Close consumer
|
||||||
|
sucker.close().unwrap();
|
||||||
|
|
||||||
|
producer_handle.join().unwrap();
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_channel_closed_error() {
|
||||||
|
let (sucker, sourcer) = SuckPair::<i32>::pair();
|
||||||
|
|
||||||
|
// Start producer
|
||||||
|
let producer_handle = thread::spawn(move || {
|
||||||
|
sourcer.set_static(42).unwrap();
|
||||||
|
sourcer.run().unwrap();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Close consumer
|
||||||
|
sucker.close().unwrap();
|
||||||
|
|
||||||
|
let result = sucker.get();
|
||||||
|
assert!(matches!(result, Err(Error::ChannelClosed)));
|
||||||
|
|
||||||
|
producer_handle.join().unwrap();
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_producer_disconnection_error() {
|
||||||
|
let (sucker, sourcer) = SuckPair::<i32>::pair();
|
||||||
|
|
||||||
|
// Start producer
|
||||||
|
let producer_handle = thread::spawn(move || {
|
||||||
|
sourcer.set_static(42).unwrap();
|
||||||
|
// Simulate crash
|
||||||
|
panic!("Producer crashed!");
|
||||||
|
});
|
||||||
|
|
||||||
|
let result = sucker.get();
|
||||||
|
assert!(matches!(result, Err(Error::ProducerDisconnected)));
|
||||||
|
|
||||||
|
let _ = producer_handle.join();
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_is_closed() {
|
||||||
|
let (sucker, sourcer) = SuckPair::<i32>::pair();
|
||||||
|
|
||||||
|
assert!(!sucker.is_closed());
|
||||||
|
|
||||||
|
// Start producer
|
||||||
|
let producer_handle = thread::spawn(move || {
|
||||||
|
sourcer.set_static(42).unwrap();
|
||||||
|
sourcer.run().unwrap();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Get one value
|
||||||
|
let _ = sucker.get().unwrap();
|
||||||
|
assert!(!sucker.is_closed());
|
||||||
|
|
||||||
|
// Close and check
|
||||||
|
sucker.close().unwrap();
|
||||||
|
|
||||||
|
producer_handle.join().unwrap();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,211 +0,0 @@
|
||||||
use std::sync::Arc;
|
|
||||||
|
|
||||||
#[cfg(feature = "sync-crossbeam")]
|
|
||||||
use crate::sync::traits::{ChannelError, ChannelReceiver, ChannelSender, ChannelType};
|
|
||||||
use crate::types;
|
|
||||||
use arc_swap::ArcSwap;
|
|
||||||
use crossbeam_channel;
|
|
||||||
|
|
||||||
type CrossbeamSucker<T> =
|
|
||||||
crate::Sucker<T, CrossbeamSender<types::Request>, CrossbeamReceiver<types::Response<T>>>;
|
|
||||||
type CrossbeamSourcer<T> =
|
|
||||||
crate::Sourcer<T, CrossbeamReceiver<types::Request>, CrossbeamSender<types::Response<T>>>;
|
|
||||||
|
|
||||||
/// Internal sender type for crossbeam backend
|
|
||||||
pub struct CrossbeamSender<T>(crossbeam_channel::Sender<T>);
|
|
||||||
/// Internal receiver type for crossbeam backend
|
|
||||||
pub struct CrossbeamReceiver<T>(crossbeam_channel::Receiver<T>);
|
|
||||||
|
|
||||||
impl<T> ChannelSender<T> for CrossbeamSender<T> {
|
|
||||||
fn send(&self, msg: T) -> Result<(), ChannelError> {
|
|
||||||
self.0
|
|
||||||
.send(msg)
|
|
||||||
.map_err(|_| ChannelError::ProducerDisconnected)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<T> ChannelReceiver<T> for CrossbeamReceiver<T> {
|
|
||||||
fn recv(&self) -> Result<T, ChannelError> {
|
|
||||||
self.0
|
|
||||||
.recv()
|
|
||||||
.map_err(|_| ChannelError::ProducerDisconnected)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Internal channel type for crossbeam backend
|
|
||||||
pub struct CrossbeamChannel;
|
|
||||||
|
|
||||||
impl ChannelType for CrossbeamChannel {
|
|
||||||
type Sender<T> = CrossbeamSender<T>;
|
|
||||||
type Receiver<T> = CrossbeamReceiver<T>;
|
|
||||||
|
|
||||||
fn create_request_channel() -> (Self::Sender<types::Request>, Self::Receiver<types::Request>) {
|
|
||||||
let (tx, rx) = crossbeam_channel::unbounded();
|
|
||||||
(CrossbeamSender(tx), CrossbeamReceiver(rx))
|
|
||||||
}
|
|
||||||
|
|
||||||
fn create_response_channel<T>() -> (
|
|
||||||
Self::Sender<types::Response<T>>,
|
|
||||||
Self::Receiver<types::Response<T>>,
|
|
||||||
) {
|
|
||||||
let (tx, rx) = crossbeam_channel::unbounded();
|
|
||||||
(CrossbeamSender(tx), CrossbeamReceiver(rx))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub struct CrossbeamSuck<T> {
|
|
||||||
_phantom: std::marker::PhantomData<T>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<T> CrossbeamSuck<T> {
|
|
||||||
pub fn pair() -> (CrossbeamSucker<T>, CrossbeamSourcer<T>)
|
|
||||||
where
|
|
||||||
T: Clone + Send + 'static,
|
|
||||||
{
|
|
||||||
let (request_tx, request_rx) = CrossbeamChannel::create_request_channel();
|
|
||||||
let (response_tx, response_rx) = CrossbeamChannel::create_response_channel::<T>();
|
|
||||||
|
|
||||||
let state = ArcSwap::new(Arc::new(crate::types::ValueSource::None));
|
|
||||||
|
|
||||||
let sucker = crate::Sucker::new(request_tx, response_rx);
|
|
||||||
let sourcer = crate::Sourcer::new(request_rx, response_tx, state);
|
|
||||||
|
|
||||||
(sucker, sourcer)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(test)]
|
|
||||||
mod tests {
|
|
||||||
use super::*;
|
|
||||||
use crate::Error;
|
|
||||||
use std::thread;
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_pre_computed_value() {
|
|
||||||
let (sucker, sourcer) = CrossbeamSuck::<i32>::pair();
|
|
||||||
|
|
||||||
// Start producer
|
|
||||||
let producer_handle = thread::spawn(move || {
|
|
||||||
sourcer.set_static(42).unwrap();
|
|
||||||
sourcer.run().unwrap();
|
|
||||||
});
|
|
||||||
|
|
||||||
// Ensure consumer gets the value
|
|
||||||
let value = sucker.get().unwrap();
|
|
||||||
assert_eq!(value, 42);
|
|
||||||
|
|
||||||
// Close consumer
|
|
||||||
sucker.close().unwrap();
|
|
||||||
|
|
||||||
producer_handle.join().unwrap();
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_closure_value() {
|
|
||||||
let (sucker, sourcer) = CrossbeamSuck::<i32>::pair();
|
|
||||||
|
|
||||||
// Start producer
|
|
||||||
let producer_handle = std::thread::spawn(move || {
|
|
||||||
let counter = std::sync::Arc::new(std::sync::Mutex::new(0));
|
|
||||||
let counter_clone = std::sync::Arc::clone(&counter);
|
|
||||||
sourcer
|
|
||||||
.set(move || {
|
|
||||||
let mut count = counter_clone.lock().unwrap();
|
|
||||||
*count += 1;
|
|
||||||
*count
|
|
||||||
})
|
|
||||||
.unwrap();
|
|
||||||
sourcer.run().unwrap();
|
|
||||||
});
|
|
||||||
|
|
||||||
// Ensure consumer gets the value
|
|
||||||
let value1 = sucker.get().unwrap();
|
|
||||||
assert_eq!(value1, 1);
|
|
||||||
|
|
||||||
// Ensure consumer gets the next value
|
|
||||||
let value2 = sucker.get().unwrap();
|
|
||||||
assert_eq!(value2, 2);
|
|
||||||
|
|
||||||
// Close consumer
|
|
||||||
sucker.close().unwrap();
|
|
||||||
|
|
||||||
producer_handle.join().unwrap();
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_no_source_error() {
|
|
||||||
let (sucker, sourcer) = CrossbeamSuck::<i32>::pair();
|
|
||||||
|
|
||||||
// Start producer
|
|
||||||
let producer_handle = thread::spawn(move || {
|
|
||||||
sourcer.run().unwrap();
|
|
||||||
});
|
|
||||||
|
|
||||||
// Consumer should get NoSource error
|
|
||||||
let result = sucker.get();
|
|
||||||
assert!(matches!(result, Err(Error::NoSource)));
|
|
||||||
|
|
||||||
// Close consumer
|
|
||||||
sucker.close().unwrap();
|
|
||||||
|
|
||||||
producer_handle.join().unwrap();
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_channel_closed_error() {
|
|
||||||
let (sucker, sourcer) = CrossbeamSuck::<i32>::pair();
|
|
||||||
|
|
||||||
// Start producer
|
|
||||||
let producer_handle = thread::spawn(move || {
|
|
||||||
sourcer.set_static(42).unwrap();
|
|
||||||
sourcer.run().unwrap();
|
|
||||||
});
|
|
||||||
|
|
||||||
// Close consumer
|
|
||||||
sucker.close().unwrap();
|
|
||||||
|
|
||||||
let result = sucker.get();
|
|
||||||
assert!(matches!(result, Err(Error::ChannelClosed)));
|
|
||||||
|
|
||||||
producer_handle.join().unwrap();
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_producer_disconnection_error() {
|
|
||||||
let (sucker, sourcer) = CrossbeamSuck::<i32>::pair();
|
|
||||||
|
|
||||||
// Start producer
|
|
||||||
let producer_handle = thread::spawn(move || {
|
|
||||||
sourcer.set_static(42).unwrap();
|
|
||||||
// Simulate crash
|
|
||||||
panic!("Producer crashed!");
|
|
||||||
});
|
|
||||||
|
|
||||||
let result = sucker.get();
|
|
||||||
assert!(matches!(result, Err(Error::ProducerDisconnected)));
|
|
||||||
|
|
||||||
let _ = producer_handle.join();
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_is_closed() {
|
|
||||||
let (sucker, sourcer) = CrossbeamSuck::<i32>::pair();
|
|
||||||
|
|
||||||
assert!(!sucker.is_closed());
|
|
||||||
|
|
||||||
// Start producer
|
|
||||||
let producer_handle = thread::spawn(move || {
|
|
||||||
sourcer.set_static(42).unwrap();
|
|
||||||
sourcer.run().unwrap();
|
|
||||||
});
|
|
||||||
|
|
||||||
// Get one value
|
|
||||||
let _ = sucker.get().unwrap();
|
|
||||||
assert!(!sucker.is_closed());
|
|
||||||
|
|
||||||
// Close and check
|
|
||||||
sucker.close().unwrap();
|
|
||||||
|
|
||||||
producer_handle.join().unwrap();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,212 +0,0 @@
|
||||||
use std::sync::Arc;
|
|
||||||
|
|
||||||
#[cfg(feature = "sync-flume")]
|
|
||||||
use crate::sync::traits::{ChannelError, ChannelReceiver, ChannelSender, ChannelType};
|
|
||||||
use crate::types;
|
|
||||||
use arc_swap::ArcSwap;
|
|
||||||
use flume;
|
|
||||||
|
|
||||||
type FlumeSucker<T> =
|
|
||||||
crate::Sucker<T, FlumeSender<types::Request>, FlumeReceiver<types::Response<T>>>;
|
|
||||||
type FlumeSourcer<T> =
|
|
||||||
crate::Sourcer<T, FlumeReceiver<types::Request>, FlumeSender<types::Response<T>>>;
|
|
||||||
|
|
||||||
/// Internal sender type for flume backend
|
|
||||||
pub struct FlumeSender<T>(flume::Sender<T>);
|
|
||||||
/// Internal receiver type for flume backend
|
|
||||||
pub struct FlumeReceiver<T>(flume::Receiver<T>);
|
|
||||||
|
|
||||||
impl<T> ChannelSender<T> for FlumeSender<T> {
|
|
||||||
fn send(&self, msg: T) -> Result<(), ChannelError> {
|
|
||||||
self.0
|
|
||||||
.send(msg)
|
|
||||||
.map_err(|_| ChannelError::ProducerDisconnected)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<T> ChannelReceiver<T> for FlumeReceiver<T> {
|
|
||||||
fn recv(&self) -> Result<T, ChannelError> {
|
|
||||||
self.0
|
|
||||||
.recv()
|
|
||||||
.map_err(|_| ChannelError::ProducerDisconnected)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Internal channel type for flume backend
|
|
||||||
pub struct FlumeChannel;
|
|
||||||
|
|
||||||
impl ChannelType for FlumeChannel {
|
|
||||||
type Sender<T> = FlumeSender<T>;
|
|
||||||
type Receiver<T> = FlumeReceiver<T>;
|
|
||||||
|
|
||||||
fn create_request_channel() -> (Self::Sender<types::Request>, Self::Receiver<types::Request>) {
|
|
||||||
let (tx, rx) = flume::unbounded();
|
|
||||||
(FlumeSender(tx), FlumeReceiver(rx))
|
|
||||||
}
|
|
||||||
|
|
||||||
fn create_response_channel<T>() -> (
|
|
||||||
Self::Sender<types::Response<T>>,
|
|
||||||
Self::Receiver<types::Response<T>>,
|
|
||||||
) {
|
|
||||||
let (tx, rx) = flume::unbounded();
|
|
||||||
(FlumeSender(tx), FlumeReceiver(rx))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub struct FlumeSuck<T> {
|
|
||||||
_phantom: std::marker::PhantomData<T>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<T> FlumeSuck<T> {
|
|
||||||
pub fn pair() -> (FlumeSucker<T>, FlumeSourcer<T>)
|
|
||||||
where
|
|
||||||
T: Clone + Send + 'static,
|
|
||||||
{
|
|
||||||
let (request_tx, request_rx) = FlumeChannel::create_request_channel();
|
|
||||||
let (response_tx, response_rx) = FlumeChannel::create_response_channel::<T>();
|
|
||||||
|
|
||||||
let state = Arc::new(crate::types::ValueSource::None);
|
|
||||||
let state = ArcSwap::new(state);
|
|
||||||
|
|
||||||
let sucker = crate::Sucker::new(request_tx, response_rx);
|
|
||||||
let sourcer = crate::Sourcer::new(request_rx, response_tx, state);
|
|
||||||
|
|
||||||
(sucker, sourcer)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(test)]
|
|
||||||
mod tests {
|
|
||||||
use super::*;
|
|
||||||
use crate::Error;
|
|
||||||
use std::thread;
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_pre_computed_value() {
|
|
||||||
let (sucker, sourcer) = FlumeSuck::<i32>::pair();
|
|
||||||
|
|
||||||
// Start producer
|
|
||||||
let producer_handle = thread::spawn(move || {
|
|
||||||
sourcer.set_static(42).unwrap();
|
|
||||||
sourcer.run().unwrap();
|
|
||||||
});
|
|
||||||
|
|
||||||
// Ensure consumer gets the value
|
|
||||||
let value = sucker.get().unwrap();
|
|
||||||
assert_eq!(value, 42);
|
|
||||||
|
|
||||||
// Close consumer
|
|
||||||
sucker.close().unwrap();
|
|
||||||
|
|
||||||
producer_handle.join().unwrap();
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_closure_value() {
|
|
||||||
let (sucker, sourcer) = FlumeSuck::<i32>::pair();
|
|
||||||
|
|
||||||
// Start producer
|
|
||||||
let producer_handle = std::thread::spawn(move || {
|
|
||||||
let counter = std::sync::Arc::new(std::sync::Mutex::new(0));
|
|
||||||
let counter_clone = std::sync::Arc::clone(&counter);
|
|
||||||
sourcer
|
|
||||||
.set(move || {
|
|
||||||
let mut count = counter_clone.lock().unwrap();
|
|
||||||
*count += 1;
|
|
||||||
*count
|
|
||||||
})
|
|
||||||
.unwrap();
|
|
||||||
sourcer.run().unwrap();
|
|
||||||
});
|
|
||||||
|
|
||||||
// Ensure consumer gets the value
|
|
||||||
let value1 = sucker.get().unwrap();
|
|
||||||
assert_eq!(value1, 1);
|
|
||||||
|
|
||||||
// Ensure consumer gets the next value
|
|
||||||
let value2 = sucker.get().unwrap();
|
|
||||||
assert_eq!(value2, 2);
|
|
||||||
|
|
||||||
// Close consumer
|
|
||||||
sucker.close().unwrap();
|
|
||||||
|
|
||||||
producer_handle.join().unwrap();
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_no_source_error() {
|
|
||||||
let (sucker, sourcer) = FlumeSuck::<i32>::pair();
|
|
||||||
|
|
||||||
// Start producer
|
|
||||||
let producer_handle = thread::spawn(move || {
|
|
||||||
sourcer.run().unwrap();
|
|
||||||
});
|
|
||||||
|
|
||||||
// Consumer should get NoSource error
|
|
||||||
let result = sucker.get();
|
|
||||||
assert!(matches!(result, Err(Error::NoSource)));
|
|
||||||
|
|
||||||
// Close consumer
|
|
||||||
sucker.close().unwrap();
|
|
||||||
|
|
||||||
producer_handle.join().unwrap();
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_channel_closed_error() {
|
|
||||||
let (sucker, sourcer) = FlumeSuck::<i32>::pair();
|
|
||||||
|
|
||||||
// Start producer
|
|
||||||
let producer_handle = thread::spawn(move || {
|
|
||||||
sourcer.set_static(42).unwrap();
|
|
||||||
sourcer.run().unwrap();
|
|
||||||
});
|
|
||||||
|
|
||||||
// Close consumer
|
|
||||||
sucker.close().unwrap();
|
|
||||||
|
|
||||||
let result = sucker.get();
|
|
||||||
assert!(matches!(result, Err(Error::ChannelClosed)));
|
|
||||||
|
|
||||||
producer_handle.join().unwrap();
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_producer_disconnection_error() {
|
|
||||||
let (sucker, sourcer) = FlumeSuck::<i32>::pair();
|
|
||||||
|
|
||||||
// Start producer
|
|
||||||
let producer_handle = thread::spawn(move || {
|
|
||||||
sourcer.set_static(42).unwrap();
|
|
||||||
// Simulate crash
|
|
||||||
panic!("Producer crashed!");
|
|
||||||
});
|
|
||||||
|
|
||||||
let result = sucker.get();
|
|
||||||
assert!(matches!(result, Err(Error::ProducerDisconnected)));
|
|
||||||
|
|
||||||
let _ = producer_handle.join();
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_is_closed() {
|
|
||||||
let (sucker, sourcer) = FlumeSuck::<i32>::pair();
|
|
||||||
|
|
||||||
assert!(!sucker.is_closed());
|
|
||||||
|
|
||||||
// Start producer
|
|
||||||
let producer_handle = thread::spawn(move || {
|
|
||||||
sourcer.set_static(42).unwrap();
|
|
||||||
sourcer.run().unwrap();
|
|
||||||
});
|
|
||||||
|
|
||||||
// Get one value
|
|
||||||
let _ = sucker.get().unwrap();
|
|
||||||
assert!(!sucker.is_closed());
|
|
||||||
|
|
||||||
// Close and check
|
|
||||||
sucker.close().unwrap();
|
|
||||||
|
|
||||||
producer_handle.join().unwrap();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,17 +0,0 @@
|
||||||
pub mod traits;
|
|
||||||
|
|
||||||
#[cfg(feature = "sync-crossbeam")]
|
|
||||||
pub mod crossbeam;
|
|
||||||
#[cfg(feature = "sync-flume")]
|
|
||||||
pub mod flume;
|
|
||||||
#[cfg(feature = "sync-std")]
|
|
||||||
pub mod std;
|
|
||||||
|
|
||||||
#[cfg(feature = "sync-flume")]
|
|
||||||
pub use flume::FlumeSuck;
|
|
||||||
|
|
||||||
#[cfg(feature = "sync-crossbeam")]
|
|
||||||
pub use crossbeam::CrossbeamSuck;
|
|
||||||
|
|
||||||
#[cfg(feature = "sync-std")]
|
|
||||||
pub use std::StdSuck;
|
|
||||||
210
src/sync/std.rs
210
src/sync/std.rs
|
|
@ -1,210 +0,0 @@
|
||||||
use arc_swap::ArcSwap;
|
|
||||||
|
|
||||||
use crate::sync::traits::{ChannelError, ChannelReceiver, ChannelSender, ChannelType};
|
|
||||||
use crate::types;
|
|
||||||
use std::sync::Arc;
|
|
||||||
#[cfg(feature = "sync-std")]
|
|
||||||
use std::sync::mpsc;
|
|
||||||
|
|
||||||
type StdSucker<T> = crate::Sucker<T, StdSender<types::Request>, StdReceiver<types::Response<T>>>;
|
|
||||||
type StdSourcer<T> = crate::Sourcer<T, StdReceiver<types::Request>, StdSender<types::Response<T>>>;
|
|
||||||
|
|
||||||
/// Internal sender type for std backend
|
|
||||||
pub struct StdSender<T>(mpsc::Sender<T>);
|
|
||||||
/// Internal receiver type for std backend
|
|
||||||
pub struct StdReceiver<T>(mpsc::Receiver<T>);
|
|
||||||
|
|
||||||
impl<T> ChannelSender<T> for StdSender<T> {
|
|
||||||
fn send(&self, msg: T) -> Result<(), ChannelError> {
|
|
||||||
self.0
|
|
||||||
.send(msg)
|
|
||||||
.map_err(|_| ChannelError::ProducerDisconnected)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<T> ChannelReceiver<T> for StdReceiver<T> {
|
|
||||||
fn recv(&self) -> Result<T, ChannelError> {
|
|
||||||
self.0
|
|
||||||
.recv()
|
|
||||||
.map_err(|_| ChannelError::ProducerDisconnected)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Internal channel type for std backend
|
|
||||||
pub struct StdChannel;
|
|
||||||
|
|
||||||
impl ChannelType for StdChannel {
|
|
||||||
type Sender<T> = StdSender<T>;
|
|
||||||
type Receiver<T> = StdReceiver<T>;
|
|
||||||
|
|
||||||
fn create_request_channel() -> (Self::Sender<types::Request>, Self::Receiver<types::Request>) {
|
|
||||||
let (tx, rx) = mpsc::channel();
|
|
||||||
(StdSender(tx), StdReceiver(rx))
|
|
||||||
}
|
|
||||||
|
|
||||||
fn create_response_channel<T>() -> (
|
|
||||||
Self::Sender<types::Response<T>>,
|
|
||||||
Self::Receiver<types::Response<T>>,
|
|
||||||
) {
|
|
||||||
let (tx, rx) = mpsc::channel();
|
|
||||||
(StdSender(tx), StdReceiver(rx))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub struct StdSuck<T> {
|
|
||||||
_phantom: std::marker::PhantomData<T>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<T> StdSuck<T> {
|
|
||||||
pub fn pair() -> (StdSucker<T>, StdSourcer<T>)
|
|
||||||
where
|
|
||||||
T: Clone + Send + 'static,
|
|
||||||
{
|
|
||||||
let (request_tx, request_rx) = StdChannel::create_request_channel();
|
|
||||||
let (response_tx, response_rx) = StdChannel::create_response_channel::<T>();
|
|
||||||
|
|
||||||
let state = Arc::new(crate::types::ValueSource::None);
|
|
||||||
let state = ArcSwap::new(state);
|
|
||||||
|
|
||||||
let sucker = crate::Sucker::new(request_tx, response_rx);
|
|
||||||
let sourcer = crate::Sourcer::new(request_rx, response_tx, state);
|
|
||||||
|
|
||||||
(sucker, sourcer)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(test)]
|
|
||||||
mod tests {
|
|
||||||
use super::*;
|
|
||||||
use crate::Error;
|
|
||||||
use std::thread;
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_pre_computed_value() {
|
|
||||||
let (sucker, sourcer) = StdSuck::<i32>::pair();
|
|
||||||
|
|
||||||
// Start producer
|
|
||||||
let producer_handle = thread::spawn(move || {
|
|
||||||
sourcer.set_static(42).unwrap();
|
|
||||||
sourcer.run().unwrap();
|
|
||||||
});
|
|
||||||
|
|
||||||
// Ensure consumer gets the value
|
|
||||||
let value = sucker.get().unwrap();
|
|
||||||
assert_eq!(value, 42);
|
|
||||||
|
|
||||||
// Close consumer
|
|
||||||
sucker.close().unwrap();
|
|
||||||
|
|
||||||
producer_handle.join().unwrap();
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_closure_value() {
|
|
||||||
let (sucker, sourcer) = StdSuck::<i32>::pair();
|
|
||||||
|
|
||||||
// Start producer
|
|
||||||
let producer_handle = std::thread::spawn(move || {
|
|
||||||
let counter = std::sync::Arc::new(std::sync::Mutex::new(0));
|
|
||||||
let counter_clone = std::sync::Arc::clone(&counter);
|
|
||||||
sourcer
|
|
||||||
.set(move || {
|
|
||||||
let mut count = counter_clone.lock().unwrap();
|
|
||||||
*count += 1;
|
|
||||||
*count
|
|
||||||
})
|
|
||||||
.unwrap();
|
|
||||||
sourcer.run().unwrap();
|
|
||||||
});
|
|
||||||
|
|
||||||
// Ensure consumer gets the value
|
|
||||||
let value1 = sucker.get().unwrap();
|
|
||||||
assert_eq!(value1, 1);
|
|
||||||
|
|
||||||
// Ensure consumer gets the next value
|
|
||||||
let value2 = sucker.get().unwrap();
|
|
||||||
assert_eq!(value2, 2);
|
|
||||||
|
|
||||||
// Close consumer
|
|
||||||
sucker.close().unwrap();
|
|
||||||
|
|
||||||
producer_handle.join().unwrap();
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_no_source_error() {
|
|
||||||
let (sucker, sourcer) = StdSuck::<i32>::pair();
|
|
||||||
|
|
||||||
// Start producer
|
|
||||||
let producer_handle = thread::spawn(move || {
|
|
||||||
sourcer.run().unwrap();
|
|
||||||
});
|
|
||||||
|
|
||||||
// Consumer should get NoSource error
|
|
||||||
let result = sucker.get();
|
|
||||||
assert!(matches!(result, Err(Error::NoSource)));
|
|
||||||
|
|
||||||
// Close consumer
|
|
||||||
sucker.close().unwrap();
|
|
||||||
|
|
||||||
producer_handle.join().unwrap();
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_channel_closed_error() {
|
|
||||||
let (sucker, sourcer) = StdSuck::<i32>::pair();
|
|
||||||
|
|
||||||
// Start producer
|
|
||||||
let producer_handle = thread::spawn(move || {
|
|
||||||
sourcer.set_static(42).unwrap();
|
|
||||||
sourcer.run().unwrap();
|
|
||||||
});
|
|
||||||
|
|
||||||
// Close consumer
|
|
||||||
sucker.close().unwrap();
|
|
||||||
|
|
||||||
let result = sucker.get();
|
|
||||||
assert!(matches!(result, Err(Error::ChannelClosed)));
|
|
||||||
|
|
||||||
producer_handle.join().unwrap();
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_producer_disconnection_error() {
|
|
||||||
let (sucker, sourcer) = StdSuck::<i32>::pair();
|
|
||||||
|
|
||||||
// Start producer
|
|
||||||
let producer_handle = thread::spawn(move || {
|
|
||||||
sourcer.set_static(42).unwrap();
|
|
||||||
// Simulate crash
|
|
||||||
panic!("Producer crashed!");
|
|
||||||
});
|
|
||||||
|
|
||||||
let result = sucker.get();
|
|
||||||
assert!(matches!(result, Err(Error::ProducerDisconnected)));
|
|
||||||
|
|
||||||
let _ = producer_handle.join();
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_is_closed() {
|
|
||||||
let (sucker, sourcer) = StdSuck::<i32>::pair();
|
|
||||||
|
|
||||||
assert!(!sucker.is_closed());
|
|
||||||
|
|
||||||
// Start producer
|
|
||||||
let producer_handle = thread::spawn(move || {
|
|
||||||
sourcer.set_static(42).unwrap();
|
|
||||||
sourcer.run().unwrap();
|
|
||||||
});
|
|
||||||
|
|
||||||
// Get one value
|
|
||||||
let _ = sucker.get().unwrap();
|
|
||||||
assert!(!sucker.is_closed());
|
|
||||||
|
|
||||||
// Close and check
|
|
||||||
sucker.close().unwrap();
|
|
||||||
|
|
||||||
producer_handle.join().unwrap();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,23 +0,0 @@
|
||||||
pub use crate::error::Error as ChannelError;
|
|
||||||
|
|
||||||
pub trait ChannelSender<T> {
|
|
||||||
fn send(&self, msg: T) -> Result<(), ChannelError>;
|
|
||||||
}
|
|
||||||
|
|
||||||
pub trait ChannelReceiver<T> {
|
|
||||||
fn recv(&self) -> Result<T, ChannelError>;
|
|
||||||
}
|
|
||||||
|
|
||||||
pub trait ChannelType {
|
|
||||||
type Sender<T>: ChannelSender<T>;
|
|
||||||
type Receiver<T>: ChannelReceiver<T>;
|
|
||||||
|
|
||||||
fn create_request_channel() -> (
|
|
||||||
Self::Sender<crate::types::Request>,
|
|
||||||
Self::Receiver<crate::types::Request>,
|
|
||||||
);
|
|
||||||
fn create_response_channel<T>() -> (
|
|
||||||
Self::Sender<crate::types::Response<T>>,
|
|
||||||
Self::Receiver<crate::types::Response<T>>,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
17
src/types.rs
17
src/types.rs
|
|
@ -1,7 +1,3 @@
|
||||||
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,
|
||||||
|
|
@ -16,13 +12,14 @@ 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 enum ValueSource<T> {
|
||||||
Static { val: T, clone: fn(&T) -> T },
|
Static(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,
|
||||||
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> = ArcSwap<ValueSource<T>>;
|
pub struct ChannelState<T> {
|
||||||
|
pub source: ValueSource<T>,
|
||||||
|
pub closed: bool,
|
||||||
|
}
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue