wlan_hw_sim/event/
filter.rs

1// Copyright 2023 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5//! Event handlers that filter their input events to more specific events.
6//!
7//! Filters are powered by the `AsEvent` trait, which extracts a reference to an event sub-type
8//! from a super-type (typically a sum type like `enum`s). The handlers composed by filters are
9//! only invoked when such a sub-type is received. Otherwise, filters return
10//! [`Handled::Unmatched`].
11//!
12//! [`Handled::Unmatched`]: crate::event::Handled
13
14use fidl_fuchsia_wlan_tap as fidl_tap;
15
16use crate::event::{Handled, Handler, StartMacArgs};
17
18// This event has no fields and is zero-size. This constant is used to return a static reference in
19// the corresponding `AsEvent` implementation.
20const START_MAC_ARGS: StartMacArgs = StartMacArgs;
21
22pub trait AsEvent<E> {
23    fn as_event(&self) -> Option<&E>;
24}
25
26impl<E> AsEvent<E> for E {
27    fn as_event(&self) -> Option<&E> {
28        Some(self)
29    }
30}
31
32impl AsEvent<fidl_tap::JoinBssArgs> for fidl_tap::WlantapPhyEvent {
33    fn as_event(&self) -> Option<&fidl_tap::JoinBssArgs> {
34        match self {
35            fidl_tap::WlantapPhyEvent::JoinBss { ref args } => Some(args),
36            _ => None,
37        }
38    }
39}
40
41impl AsEvent<fidl_tap::StartScanArgs> for fidl_tap::WlantapPhyEvent {
42    fn as_event(&self) -> Option<&fidl_tap::StartScanArgs> {
43        match self {
44            fidl_tap::WlantapPhyEvent::StartScan { ref args } => Some(args),
45            _ => None,
46        }
47    }
48}
49
50impl AsEvent<fidl_tap::SetChannelArgs> for fidl_tap::WlantapPhyEvent {
51    fn as_event(&self) -> Option<&fidl_tap::SetChannelArgs> {
52        match self {
53            fidl_tap::WlantapPhyEvent::SetChannel { ref args } => Some(args),
54            _ => None,
55        }
56    }
57}
58
59impl AsEvent<fidl_tap::SetCountryArgs> for fidl_tap::WlantapPhyEvent {
60    fn as_event(&self) -> Option<&fidl_tap::SetCountryArgs> {
61        match self {
62            fidl_tap::WlantapPhyEvent::SetCountry { ref args } => Some(args),
63            _ => None,
64        }
65    }
66}
67
68impl AsEvent<StartMacArgs> for fidl_tap::WlantapPhyEvent {
69    fn as_event(&self) -> Option<&StartMacArgs> {
70        match self {
71            fidl_tap::WlantapPhyEvent::WlanSoftmacStart { .. } => Some(&START_MAC_ARGS),
72            _ => None,
73        }
74    }
75}
76
77impl AsEvent<fidl_tap::TxArgs> for fidl_tap::WlantapPhyEvent {
78    fn as_event(&self) -> Option<&fidl_tap::TxArgs> {
79        match self {
80            fidl_tap::WlantapPhyEvent::Tx { ref args } => Some(args),
81            _ => None,
82        }
83    }
84}
85
86/// Filters [`WlantapPhyEvent`]s to [`JoinBssArgs`].
87///
88/// The composed event handler must accept [`JoinBssArgs`] and is only invoked when such an event
89/// is received by the filter. Otherwise, the filter returns [`Handled::Unmatched`].
90///
91/// [`Handled::Unmatched`]: crate::event::Handled::Unmatched
92/// [`JoinBssArgs`]: fidl_fuchsia_wlan_tap::JoinBssArgs
93/// [`WlantapPhyEvent`]: fidl_fuchsia_wlan_tap::WlantapPhyEvent
94pub fn on_join_bss<H, S, E>(handler: H) -> impl Handler<S, E, Output = H::Output>
95where
96    H: Handler<S, fidl_tap::JoinBssArgs>,
97    E: AsEvent<fidl_tap::JoinBssArgs>,
98{
99    filter(handler)
100}
101
102/// Filters [`WlantapPhyEvent`]s to [`StartScanArgs`].
103///
104/// The composed event handler must accept [`StartScanArgs`] and is only invoked when such an event
105/// is received by the filter. Otherwise, the filter returns [`Handled::Unmatched`].
106///
107/// [`Handled::Unmatched`]: crate::event::Handled::Unmatched
108/// [`StartScanArgs`]: fidl_fuchsia_wlan_tap::StartScanArgs
109/// [`WlantapPhyEvent`]: fidl_fuchsia_wlan_tap::WlantapPhyEvent
110pub fn on_scan<H, S, E>(handler: H) -> impl Handler<S, E, Output = H::Output>
111where
112    H: Handler<S, fidl_tap::StartScanArgs>,
113    E: AsEvent<fidl_tap::StartScanArgs>,
114{
115    filter(handler)
116}
117
118/// Filters [`WlantapPhyEvent`]s to [`SetChannelArgs`].
119///
120/// The composed event handler must accept [`SetChannelArgs`] and is only invoked when such an
121/// event is received by the filter. Otherwise, the filter returns [`Handled::Unmatched`].
122///
123/// [`Handled::Unmatched`]: crate::event::Handled::Unmatched
124/// [`SetChannelArgs`]: fidl_fuchsia_wlan_tap::SetChannelArgs
125/// [`WlantapPhyEvent`]: fidl_fuchsia_wlan_tap::WlantapPhyEvent
126pub fn on_set_channel<H, S, E>(handler: H) -> impl Handler<S, E, Output = H::Output>
127where
128    H: Handler<S, fidl_tap::SetChannelArgs>,
129    E: AsEvent<fidl_tap::SetChannelArgs>,
130{
131    filter(handler)
132}
133
134/// Filters [`WlantapPhyEvent`]s to [`SetCountryArgs`].
135///
136/// The composed event handler must accept [`SetCountryArgs`] and is only invoked when such an
137/// event is received by the filter. Otherwise, the filter returns [`Handled::Unmatched`].
138///
139/// [`Handled::Unmatched`]: crate::event::Handled::Unmatched
140/// [`SetCountryArgs`]: fidl_fuchsia_wlan_tap::SetCountryArgs
141/// [`WlantapPhyEvent`]: fidl_fuchsia_wlan_tap::WlantapPhyEvent
142pub fn on_set_country<H, S, E>(handler: H) -> impl Handler<S, E, Output = H::Output>
143where
144    H: Handler<S, fidl_tap::SetCountryArgs>,
145    E: AsEvent<fidl_tap::SetCountryArgs>,
146{
147    filter(handler)
148}
149
150/// Filters [`WlantapPhyEvent`]s to [`StartMacArgs`].
151///
152/// The composed event handler must accept [`StartMacArgs`] and is only invoked when such an
153/// event is received by the filter. Otherwise, the filter returns [`Handled::Unmatched`].
154///
155/// [`Handled::Unmatched`]: crate::event::Handled::Unmatched
156/// [`StartMacArgs`]: crate::event::StartMacArgs
157/// [`WlantapPhyEvent`]: fidl_fuchsia_wlan_tap::WlantapPhyEvent
158pub fn on_start_mac<H, S, E>(handler: H) -> impl Handler<S, E, Output = H::Output>
159where
160    H: Handler<S, StartMacArgs>,
161    E: AsEvent<StartMacArgs>,
162{
163    filter(handler)
164}
165
166/// Filters [`WlantapPhyEvent`]s to [`TxArgs`].
167///
168/// The composed event handler must accept [`TxArgs`] and is only invoked when such an event is
169/// received by the filter. Otherwise, the filter returns [`Handled::Unmatched`].
170///
171/// [`Handled::Unmatched`]: crate::event::Handled::Unmatched
172/// [`TxArgs`]: fidl_fuchsia_wlan_tap::TxArgs
173/// [`WlantapPhyEvent`]: fidl_fuchsia_wlan_tap::WlantapPhyEvent
174pub fn on_transmit<H, S, E>(handler: H) -> impl Handler<S, E, Output = H::Output>
175where
176    H: Handler<S, fidl_tap::TxArgs>,
177    E: AsEvent<fidl_tap::TxArgs>,
178{
179    filter(handler)
180}
181
182/// Filters `E1` events to more specific `E2` events.
183///
184/// It must be possible to extract a reference to an `E2` from an `E1` via `AsEvent` to use this
185/// function. The composed event handler must accept `E2` events and is only invoked when the
186/// filter receives an `E1` event from which an `E2` event can be retrieved. Otherwise, the filter
187/// returns [`Handled::Unmatched`].
188///
189/// [`Handled::Unmatched`]: crate::event::Handled::Unmatched
190fn filter<H, S, E1, E2>(mut handler: H) -> impl Handler<S, E1, Output = H::Output>
191where
192    H: Handler<S, E2>,
193    E1: AsEvent<E2>,
194{
195    move |state: &mut S, event: &E1| match event.as_event() {
196        Some(event) => handler.call(state, event),
197        _ => Handled::Unmatched,
198    }
199}
wlan_hw_sim/event/filter.rs

wlan_hw_sim/event/
filter.rs
