Skip to main content

ya_smoltcp/phy/
loopback.rs

1#[cfg(not(feature = "rust-1_28"))]
2use alloc::collections::VecDeque;
3use alloc::vec::Vec;
4#[cfg(feature = "rust-1_28")]
5use alloc::VecDeque;
6
7use crate::phy::{self, Device, DeviceCapabilities, Medium};
8use crate::time::Instant;
9use crate::Result;
10
11/// A loopback device.
12#[derive(Debug)]
13pub struct Loopback {
14    queue: VecDeque<Vec<u8>>,
15    medium: Medium,
16}
17
18#[allow(clippy::new_without_default)]
19impl Loopback {
20    /// Creates a loopback device.
21    ///
22    /// Every packet transmitted through this device will be received through it
23    /// in FIFO order.
24    pub fn new(medium: Medium) -> Loopback {
25        Loopback {
26            queue: VecDeque::new(),
27            medium,
28        }
29    }
30}
31
32impl<'a> Device<'a> for Loopback {
33    type RxToken = RxToken;
34    type TxToken = TxToken<'a>;
35
36    fn capabilities(&self) -> DeviceCapabilities {
37        DeviceCapabilities {
38            max_transmission_unit: 65535,
39            medium: self.medium,
40            ..DeviceCapabilities::default()
41        }
42    }
43
44    fn receive(&'a mut self) -> Option<(Self::RxToken, Self::TxToken)> {
45        self.queue.pop_front().map(move |buffer| {
46            let rx = RxToken { buffer };
47            let tx = TxToken {
48                queue: &mut self.queue,
49            };
50            (rx, tx)
51        })
52    }
53
54    fn transmit(&'a mut self) -> Option<Self::TxToken> {
55        Some(TxToken {
56            queue: &mut self.queue,
57        })
58    }
59}
60
61#[doc(hidden)]
62pub struct RxToken {
63    buffer: Vec<u8>,
64}
65
66impl phy::RxToken for RxToken {
67    fn consume<R, F>(mut self, _timestamp: Instant, f: F) -> Result<R>
68    where
69        F: FnOnce(&mut [u8]) -> Result<R>,
70    {
71        f(&mut self.buffer)
72    }
73}
74
75#[doc(hidden)]
76pub struct TxToken<'a> {
77    queue: &'a mut VecDeque<Vec<u8>>,
78}
79
80impl<'a> phy::TxToken for TxToken<'a> {
81    fn consume<R, F>(self, _timestamp: Instant, len: usize, f: F) -> Result<R>
82    where
83        F: FnOnce(&mut [u8]) -> Result<R>,
84    {
85        let mut buffer = Vec::new();
86        buffer.resize(len, 0);
87        let result = f(&mut buffer);
88        self.queue.push_back(buffer);
89        result
90    }
91}