max/embassy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Deprecate *recv* in favor of *receive*

Browse Source
This commit is contained in:
Ruben De Smet 2023-08-11 11:58:22 +02:00
parent b1ec460b9a
commit c39671266e
No known key found for this signature in database
GPG Key ID: 1AE26A210C14115B
14 changed files with 63 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
embassy-stm32-wpan/src/mac/driver.rs
View File

@ -93,7 +93,7 @@ impl<'d> embassy_net_driver::RxToken for RxToken<'d> {
{ {
// Only valid data events should be put into the queue // Only valid data events should be put into the queue
let data_event = match self.rx.try_recv().unwrap() { let data_event = match self.rx.try_receive().unwrap() {
MacEvent::McpsDataInd(data_event) => data_event, MacEvent::McpsDataInd(data_event) => data_event,
_ => unreachable!(), _ => unreachable!(),
}; };
@ -113,7 +113,7 @@ impl<'d> embassy_net_driver::TxToken for TxToken<'d> {
F: FnOnce(&mut [u8]) -> R, F: FnOnce(&mut [u8]) -> R,
{ {
// Only valid tx buffers should be put into the queue // Only valid tx buffers should be put into the queue
let buf = self.tx_buf.try_recv().unwrap(); let buf = self.tx_buf.try_receive().unwrap();
let r = f(&mut buf[..len]); let r = f(&mut buf[..len]);
// The tx channel should always be of equal capacity to the tx_buf channel // The tx channel should always be of equal capacity to the tx_buf channel

2
embassy-stm32-wpan/src/mac/runner.rs
View File

@ -73,7 +73,7 @@ impl<'a> Runner<'a> {
let mut msdu_handle = 0x02; let mut msdu_handle = 0x02;
loop { loop {
let (buf, len) = self.tx_channel.recv().await; let (buf, len) = self.tx_channel.receive().await;
let _wm = self.write_mutex.lock().await; let _wm = self.write_mutex.lock().await;
// The mutex should be dropped on the next loop iteration // The mutex should be dropped on the next loop iteration

4
embassy-stm32/src/can/bxcan.rs
View File

@ -478,7 +478,7 @@ impl<'c, 'd, T: Instance> CanRx<'c, 'd, T> {
pub async fn read(&mut self) -> Result<Envelope, BusError> { pub async fn read(&mut self) -> Result<Envelope, BusError> {
poll_fn(|cx| { poll_fn(|cx| {
T::state().err_waker.register(cx.waker()); T::state().err_waker.register(cx.waker());
if let Poll::Ready(envelope) = T::state().rx_queue.recv().poll_unpin(cx) { if let Poll::Ready(envelope) = T::state().rx_queue.receive().poll_unpin(cx) {
return Poll::Ready(Ok(envelope)); return Poll::Ready(Ok(envelope));
} else if let Some(err) = self.curr_error() { } else if let Some(err) = self.curr_error() {
return Poll::Ready(Err(err)); return Poll::Ready(Err(err));
@ -493,7 +493,7 @@ impl<'c, 'd, T: Instance> CanRx<'c, 'd, T> {
/// ///
/// Returns [Err(TryReadError::Empty)] if there are no frames in the rx queue. /// Returns [Err(TryReadError::Empty)] if there are no frames in the rx queue.
pub fn try_read(&mut self) -> Result<Envelope, TryReadError> { pub fn try_read(&mut self) -> Result<Envelope, TryReadError> {
if let Ok(envelope) = T::state().rx_queue.try_recv() { if let Ok(envelope) = T::state().rx_queue.try_receive() {
return Ok(envelope); return Ok(envelope);
} }

88
embassy-sync/src/channel.rs
View File

@ -147,16 +147,16 @@ where
{ {
/// Receive the next value. /// Receive the next value.
/// ///
/// See [`Channel::recv()`]. /// See [`Channel::receive()`].
pub fn recv(&self) -> RecvFuture<'_, M, T, N> { pub fn receive(&self) -> ReceiveFuture<'_, M, T, N> {
self.channel.recv() self.channel.receive()
} }
/// Attempt to immediately receive the next value. /// Attempt to immediately receive the next value.
/// ///
/// See [`Channel::try_recv()`] /// See [`Channel::try_receive()`]
pub fn try_recv(&self) -> Result<T, TryRecvError> { pub fn try_receive(&self) -> Result<T, TryReceiveError> {
self.channel.try_recv() self.channel.try_receive()
} }
/// Allows a poll_fn to poll until the channel is ready to receive /// Allows a poll_fn to poll until the channel is ready to receive
@ -190,16 +190,16 @@ impl<'ch, T> Copy for DynamicReceiver<'ch, T> {}
impl<'ch, T> DynamicReceiver<'ch, T> { impl<'ch, T> DynamicReceiver<'ch, T> {
/// Receive the next value. /// Receive the next value.
/// ///
/// See [`Channel::recv()`]. /// See [`Channel::receive()`].
pub fn recv(&self) -> DynamicRecvFuture<'_, T> { pub fn receive(&self) -> DynamicReceiveFuture<'_, T> {
DynamicRecvFuture { channel: self.channel } DynamicReceiveFuture { channel: self.channel }
} }
/// Attempt to immediately receive the next value. /// Attempt to immediately receive the next value.
/// ///
/// See [`Channel::try_recv()`] /// See [`Channel::try_receive()`]
pub fn try_recv(&self) -> Result<T, TryRecvError> { pub fn try_receive(&self) -> Result<T, TryReceiveError> {
self.channel.try_recv_with_context(None) self.channel.try_receive_with_context(None)
} }
/// Allows a poll_fn to poll until the channel is ready to receive /// Allows a poll_fn to poll until the channel is ready to receive
@ -226,16 +226,16 @@ where
} }
} }
/// Future returned by [`Channel::recv`] and [`Receiver::recv`]. /// Future returned by [`Channel::receive`] and [`Receiver::receive`].
#[must_use = "futures do nothing unless you `.await` or poll them"] #[must_use = "futures do nothing unless you `.await` or poll them"]
pub struct RecvFuture<'ch, M, T, const N: usize> pub struct ReceiveFuture<'ch, M, T, const N: usize>
where where
M: RawMutex, M: RawMutex,
{ {
channel: &'ch Channel<M, T, N>, channel: &'ch Channel<M, T, N>,
} }
impl<'ch, M, T, const N: usize> Future for RecvFuture<'ch, M, T, N> impl<'ch, M, T, const N: usize> Future for ReceiveFuture<'ch, M, T, N>
where where
M: RawMutex, M: RawMutex,
{ {
@ -246,19 +246,19 @@ where
} }
} }
/// Future returned by [`DynamicReceiver::recv`]. /// Future returned by [`DynamicReceiver::receive`].
#[must_use = "futures do nothing unless you `.await` or poll them"] #[must_use = "futures do nothing unless you `.await` or poll them"]
pub struct DynamicRecvFuture<'ch, T> { pub struct DynamicReceiveFuture<'ch, T> {
channel: &'ch dyn DynamicChannel<T>, channel: &'ch dyn DynamicChannel<T>,
} }
impl<'ch, T> Future for DynamicRecvFuture<'ch, T> { impl<'ch, T> Future for DynamicReceiveFuture<'ch, T> {
type Output = T; type Output = T;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<T> { fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<T> {
match self.channel.try_recv_with_context(Some(cx)) { match self.channel.try_receive_with_context(Some(cx)) {
Ok(v) => Poll::Ready(v), Ok(v) => Poll::Ready(v),
Err(TryRecvError::Empty) => Poll::Pending, Err(TryReceiveError::Empty) => Poll::Pending,
} }
} }
} }
@ -324,7 +324,7 @@ impl<'ch, T> Unpin for DynamicSendFuture<'ch, T> {}
trait DynamicChannel<T> { trait DynamicChannel<T> {
fn try_send_with_context(&self, message: T, cx: Option<&mut Context<'_>>) -> Result<(), TrySendError<T>>; fn try_send_with_context(&self, message: T, cx: Option<&mut Context<'_>>) -> Result<(), TrySendError<T>>;
fn try_recv_with_context(&self, cx: Option<&mut Context<'_>>) -> Result<T, TryRecvError>; fn try_receive_with_context(&self, cx: Option<&mut Context<'_>>) -> Result<T, TryReceiveError>;
fn poll_ready_to_send(&self, cx: &mut Context<'_>) -> Poll<()>; fn poll_ready_to_send(&self, cx: &mut Context<'_>) -> Poll<()>;
fn poll_ready_to_receive(&self, cx: &mut Context<'_>) -> Poll<()>; fn poll_ready_to_receive(&self, cx: &mut Context<'_>) -> Poll<()>;
@ -332,10 +332,10 @@ trait DynamicChannel<T> {
fn poll_receive(&self, cx: &mut Context<'_>) -> Poll<T>; fn poll_receive(&self, cx: &mut Context<'_>) -> Poll<T>;
} }
/// Error returned by [`try_recv`](Channel::try_recv). /// Error returned by [`try_receive`](Channel::try_receive).
#[derive(PartialEq, Eq, Clone, Copy, Debug)] #[derive(PartialEq, Eq, Clone, Copy, Debug)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))] #[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum TryRecvError { pub enum TryReceiveError {
/// A message could not be received because the channel is empty. /// A message could not be received because the channel is empty.
Empty, Empty,
} }
@ -364,11 +364,11 @@ impl<T, const N: usize> ChannelState<T, N> {
} }
} }
fn try_recv(&mut self) -> Result<T, TryRecvError> { fn try_receive(&mut self) -> Result<T, TryReceiveError> {
self.try_recv_with_context(None) self.try_receive_with_context(None)
} }
fn try_recv_with_context(&mut self, cx: Option<&mut Context<'_>>) -> Result<T, TryRecvError> { fn try_receive_with_context(&mut self, cx: Option<&mut Context<'_>>) -> Result<T, TryReceiveError> {
if self.queue.is_full() { if self.queue.is_full() {
self.senders_waker.wake(); self.senders_waker.wake();
} }
@ -379,7 +379,7 @@ impl<T, const N: usize> ChannelState<T, N> {
if let Some(cx) = cx { if let Some(cx) = cx {
self.receiver_waker.register(cx.waker()); self.receiver_waker.register(cx.waker());
} }
Err(TryRecvError::Empty) Err(TryReceiveError::Empty)
} }
} }
@ -474,8 +474,8 @@ where
self.inner.lock(|rc| f(&mut *rc.borrow_mut())) self.inner.lock(|rc| f(&mut *rc.borrow_mut()))
} }
fn try_recv_with_context(&self, cx: Option<&mut Context<'_>>) -> Result<T, TryRecvError> { fn try_receive_with_context(&self, cx: Option<&mut Context<'_>>) -> Result<T, TryReceiveError> {
self.lock(|c| c.try_recv_with_context(cx)) self.lock(|c| c.try_receive_with_context(cx))
} }
/// Poll the channel for the next message /// Poll the channel for the next message
@ -536,16 +536,16 @@ where
/// ///
/// If there are no messages in the channel's buffer, this method will /// If there are no messages in the channel's buffer, this method will
/// wait until a message is sent. /// wait until a message is sent.
pub fn recv(&self) -> RecvFuture<'_, M, T, N> { pub fn receive(&self) -> ReceiveFuture<'_, M, T, N> {
RecvFuture { channel: self } ReceiveFuture { channel: self }
} }
/// Attempt to immediately receive a message. /// Attempt to immediately receive a message.
/// ///
/// This method will either receive a message from the channel immediately or return an error /// This method will either receive a message from the channel immediately or return an error
/// if the channel is empty. /// if the channel is empty.
pub fn try_recv(&self) -> Result<T, TryRecvError> { pub fn try_receive(&self) -> Result<T, TryReceiveError> {
self.lock(|c| c.try_recv()) self.lock(|c| c.try_receive())
} }
} }
@ -559,8 +559,8 @@ where
Channel::try_send_with_context(self, m, cx) Channel::try_send_with_context(self, m, cx)
} }
fn try_recv_with_context(&self, cx: Option<&mut Context<'_>>) -> Result<T, TryRecvError> { fn try_receive_with_context(&self, cx: Option<&mut Context<'_>>) -> Result<T, TryReceiveError> {
Channel::try_recv_with_context(self, cx) Channel::try_receive_with_context(self, cx)
} }
fn poll_ready_to_send(&self, cx: &mut Context<'_>) -> Poll<()> { fn poll_ready_to_send(&self, cx: &mut Context<'_>) -> Poll<()> {
@ -616,15 +616,15 @@ mod tests {
fn receiving_once_with_one_send() { fn receiving_once_with_one_send() {
let mut c = ChannelState::<u32, 3>::new(); let mut c = ChannelState::<u32, 3>::new();
assert!(c.try_send(1).is_ok()); assert!(c.try_send(1).is_ok());
assert_eq!(c.try_recv().unwrap(), 1); assert_eq!(c.try_receive().unwrap(), 1);
assert_eq!(capacity(&c), 3); assert_eq!(capacity(&c), 3);
} }
#[test] #[test]
fn receiving_when_empty() { fn receiving_when_empty() {
let mut c = ChannelState::<u32, 3>::new(); let mut c = ChannelState::<u32, 3>::new();
match c.try_recv() { match c.try_receive() {
Err(TryRecvError::Empty) => assert!(true), Err(TryReceiveError::Empty) => assert!(true),
_ => assert!(false), _ => assert!(false),
} }
assert_eq!(capacity(&c), 3); assert_eq!(capacity(&c), 3);
@ -634,7 +634,7 @@ mod tests {
fn simple_send_and_receive() { fn simple_send_and_receive() {
let c = Channel::<NoopRawMutex, u32, 3>::new(); let c = Channel::<NoopRawMutex, u32, 3>::new();
assert!(c.try_send(1).is_ok()); assert!(c.try_send(1).is_ok());
assert_eq!(c.try_recv().unwrap(), 1); assert_eq!(c.try_receive().unwrap(), 1);
} }
#[test] #[test]
@ -654,7 +654,7 @@ mod tests {
let r: DynamicReceiver<'_, u32> = c.receiver().into(); let r: DynamicReceiver<'_, u32> = c.receiver().into();
assert!(s.try_send(1).is_ok()); assert!(s.try_send(1).is_ok());
assert_eq!(r.try_recv().unwrap(), 1); assert_eq!(r.try_receive().unwrap(), 1);
} }
#[futures_test::test] #[futures_test::test]
@ -669,14 +669,14 @@ mod tests {
assert!(c2.try_send(1).is_ok()); assert!(c2.try_send(1).is_ok());
}) })
.is_ok()); .is_ok());
assert_eq!(c.recv().await, 1); assert_eq!(c.receive().await, 1);
} }
#[futures_test::test] #[futures_test::test]
async fn sender_send_completes_if_capacity() { async fn sender_send_completes_if_capacity() {
let c = Channel::<CriticalSectionRawMutex, u32, 1>::new(); let c = Channel::<CriticalSectionRawMutex, u32, 1>::new();
c.send(1).await; c.send(1).await;
assert_eq!(c.recv().await, 1); assert_eq!(c.receive().await, 1);
} }
#[futures_test::test] #[futures_test::test]
@ -694,11 +694,11 @@ mod tests {
// Wish I could think of a means of determining that the async send is waiting instead. // Wish I could think of a means of determining that the async send is waiting instead.
// However, I've used the debugger to observe that the send does indeed wait. // However, I've used the debugger to observe that the send does indeed wait.
Delay::new(Duration::from_millis(500)).await; Delay::new(Duration::from_millis(500)).await;
assert_eq!(c.recv().await, 1); assert_eq!(c.receive().await, 1);
assert!(executor assert!(executor
.spawn(async move { .spawn(async move {
loop { loop {
c.recv().await; c.receive().await;
} }
}) })
.is_ok()); .is_ok());

2
examples/nrf52840/src/bin/channel.rs
View File

@ -35,7 +35,7 @@ async fn main(spawner: Spawner) {
unwrap!(spawner.spawn(my_task())); unwrap!(spawner.spawn(my_task()));
loop { loop {
match CHANNEL.recv().await { match CHANNEL.receive().await {
LedState::On => led.set_high(), LedState::On => led.set_high(),
LedState::Off => led.set_low(), LedState::Off => led.set_low(),
} }

2
examples/nrf52840/src/bin/channel_sender_receiver.rs
View File

@ -33,7 +33,7 @@ async fn recv_task(led: AnyPin, receiver: Receiver<'static, NoopRawMutex, LedSta
let mut led = Output::new(led, Level::Low, OutputDrive::Standard); let mut led = Output::new(led, Level::Low, OutputDrive::Standard);
loop { loop {
match receiver.recv().await { match receiver.receive().await {
LedState::On => led.set_high(), LedState::On => led.set_high(),
LedState::Off => led.set_low(), LedState::Off => led.set_low(),
} }

2
examples/nrf52840/src/bin/uart_split.rs
View File

@ -46,7 +46,7 @@ async fn main(spawner: Spawner) {
// back out the buffer we receive from the read // back out the buffer we receive from the read
// task. // task.
loop { loop {
let buf = CHANNEL.recv().await; let buf = CHANNEL.receive().await;
info!("writing..."); info!("writing...");
unwrap!(tx.write(&buf).await); unwrap!(tx.write(&buf).await);
} }

2
examples/rp/src/bin/lora_p2p_send_multicore.rs
View File

@ -113,7 +113,7 @@ async fn core1_task(
}; };
loop { loop {
let buffer: [u8; 3] = CHANNEL.recv().await; let buffer: [u8; 3] = CHANNEL.receive().await;
match lora.prepare_for_tx(&mdltn_params, 20, false).await { match lora.prepare_for_tx(&mdltn_params, 20, false).await {
Ok(()) => {} Ok(()) => {}
Err(err) => { Err(err) => {

2
examples/rp/src/bin/multicore.rs
View File

@ -56,7 +56,7 @@ async fn core0_task() {
async fn core1_task(mut led: Output<'static, PIN_25>) { async fn core1_task(mut led: Output<'static, PIN_25>) {
info!("Hello from core 1"); info!("Hello from core 1");
loop { loop {
match CHANNEL.recv().await { match CHANNEL.receive().await {
LedState::On => led.set_high(), LedState::On => led.set_high(),
LedState::Off => led.set_low(), LedState::Off => led.set_low(),
} }

4
examples/stm32f3/src/bin/button_events.rs
View File

@ -49,12 +49,12 @@ impl<'a> Leds<'a> {
async fn show(&mut self) { async fn show(&mut self) {
self.leds[self.current_led].set_high(); self.leds[self.current_led].set_high();
if let Ok(new_message) = with_timeout(Duration::from_millis(500), CHANNEL.recv()).await { if let Ok(new_message) = with_timeout(Duration::from_millis(500), CHANNEL.receive()).await {
self.leds[self.current_led].set_low(); self.leds[self.current_led].set_low();
self.process_event(new_message).await; self.process_event(new_message).await;
} else { } else {
self.leds[self.current_led].set_low(); self.leds[self.current_led].set_low();
if let Ok(new_message) = with_timeout(Duration::from_millis(200), CHANNEL.recv()).await { if let Ok(new_message) = with_timeout(Duration::from_millis(200), CHANNEL.receive()).await {
self.process_event(new_message).await; self.process_event(new_message).await;
} }
} }

2
examples/stm32h5/src/bin/usart_split.rs
View File

@ -44,7 +44,7 @@ async fn main(spawner: Spawner) -> ! {
unwrap!(spawner.spawn(reader(rx))); unwrap!(spawner.spawn(reader(rx)));
loop { loop {
let buf = CHANNEL.recv().await; let buf = CHANNEL.receive().await;
info!("writing..."); info!("writing...");
unwrap!(tx.write(&buf).await); unwrap!(tx.write(&buf).await);
} }

2
examples/stm32h7/src/bin/usart_split.rs
View File

@ -44,7 +44,7 @@ async fn main(spawner: Spawner) -> ! {
unwrap!(spawner.spawn(reader(rx))); unwrap!(spawner.spawn(reader(rx)));
loop { loop {
let buf = CHANNEL.recv().await; let buf = CHANNEL.receive().await;
info!("writing..."); info!("writing...");
unwrap!(tx.write(&buf).await); unwrap!(tx.write(&buf).await);
} }

6
tests/rp/src/bin/gpio_multicore.rs
View File

@ -38,11 +38,11 @@ async fn core0_task(p: PIN_0) {
let mut pin = Output::new(p, Level::Low); let mut pin = Output::new(p, Level::Low);
CHANNEL0.send(()).await; CHANNEL0.send(()).await;
CHANNEL1.recv().await; CHANNEL1.receive().await;
pin.set_high(); pin.set_high();
CHANNEL1.recv().await; CHANNEL1.receive().await;
info!("Test OK"); info!("Test OK");
cortex_m::asm::bkpt(); cortex_m::asm::bkpt();
@ -52,7 +52,7 @@ async fn core0_task(p: PIN_0) {
async fn core1_task(p: PIN_1) { async fn core1_task(p: PIN_1) {
info!("CORE1 is running"); info!("CORE1 is running");
CHANNEL0.recv().await; CHANNEL0.receive().await;
let mut pin = Input::new(p, Pull::Down); let mut pin = Input::new(p, Pull::Down);
let wait = pin.wait_for_rising_edge(); let wait = pin.wait_for_rising_edge();

4
tests/rp/src/bin/multicore.rs
View File

@ -34,7 +34,7 @@ async fn core0_task() {
info!("CORE0 is running"); info!("CORE0 is running");
let ping = true; let ping = true;
CHANNEL0.send(ping).await; CHANNEL0.send(ping).await;
let pong = CHANNEL1.recv().await; let pong = CHANNEL1.receive().await;
assert_eq!(ping, pong); assert_eq!(ping, pong);
info!("Test OK"); info!("Test OK");
@ -44,6 +44,6 @@ async fn core0_task() {
#[embassy_executor::task] #[embassy_executor::task]
async fn core1_task() { async fn core1_task() {
info!("CORE1 is running"); info!("CORE1 is running");
let ping = CHANNEL0.recv().await; let ping = CHANNEL0.receive().await;
CHANNEL1.send(ping).await; CHANNEL1.send(ping).await;
} }