aipack 0.8.23

Command Agent runner to accelerate production coding with genai.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

//! Application channel normalization
//! - Use flume for async/sync convenient
//! - Implement send(impl Into)
//! - Default to async and _sync suffix for sync
//!
//! A good way to wrap a Event type to provide a domain type:
//! ```rust
//! #[derive(Clone, From, Deref)]
//! pub struct RunQueueTx(Tx<RunQueueEvent>);
//! ```

use crate::{Error, Result};

/// Create a new unbounded channel
/// - `name` - The static name of the channel (for better error reporting)
pub fn new_channel<T>(name: &'static str) -> (Tx<T>, Rx<T>) {
	let (tx, rx) = flume::unbounded();

	(Tx(tx, name), Rx(rx, name))
}

// region:    --- Tx

// Tx with the channel name
#[derive(Debug)]
pub struct Tx<T>(flume::Sender<T>, &'static str);

impl<T> Tx<T> {
	/// Asynchronous send (preferred).
	pub async fn send(&self, value: impl Into<T>) -> Result<()> {
		self.0.send_async(value.into()).await.map_err(|err| Error::ChannelTx {
			name: self.1,
			cause: err.to_string(),
		})
	}

	/// Synchronous send (`_sync` suffix for clarity).
	pub fn send_sync(&self, value: impl Into<T>) -> Result<()> {
		self.0.send(value.into()).map_err(|err| Error::ChannelTx {
			name: self.1,
			cause: err.to_string(),
		})
	}
}

impl<T> Clone for Tx<T> {
	fn clone(&self) -> Self {
		Self(self.0.clone(), self.1)
	}
}

// endregion: --- Tx

// region:    --- Rx

// Rx with the channel name
pub struct Rx<T>(flume::Receiver<T>, &'static str);

impl<T> Rx<T> {
	/// Asynchronous receive (preferred).
	pub async fn recv(&self) -> Result<T> {
		self.0.recv_async().await.map_err(|err| Error::ChannelRx {
			name: self.1,
			cause: err.to_string(),
		})
	}

	/// Synchronous receive (`_sync` suffix for clarity).
	#[allow(unused)]
	pub fn recv_sync(&self) -> Result<T> {
		self.0.recv().map_err(|err| Error::ChannelRx {
			name: self.1,
			cause: err.to_string(),
		})
	}

	/// Non-blocking receive.
	/// Returns `Ok(None)` if channel is empty.
	pub fn try_recv(&self) -> Result<Option<T>> {
		match self.0.try_recv() {
			Ok(v) => Ok(Some(v)),
			Err(flume::TryRecvError::Empty) => Ok(None),
			Err(err @ flume::TryRecvError::Disconnected) => Err(Error::ChannelRx {
				name: self.1,
				cause: err.to_string(),
			}),
		}
	}
}

impl<T> Clone for Rx<T> {
	fn clone(&self) -> Self {
		Self(self.0.clone(), self.1)
	}
}

// endregion: --- Rx