From 734ea29c6fa630c9039892668a7a37545b4347fc Mon Sep 17 00:00:00 2001 From: Markus Pettersson Date: Fri, 15 Mar 2024 10:09:51 +0100 Subject: [PATCH] Update docs for `RelaySelector` --- mullvad-relay-selector/src/relay_selector/matcher.rs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/mullvad-relay-selector/src/relay_selector/matcher.rs b/mullvad-relay-selector/src/relay_selector/matcher.rs index bca7cb39c4c4..1da39e4d2233 100644 --- a/mullvad-relay-selector/src/relay_selector/matcher.rs +++ b/mullvad-relay-selector/src/relay_selector/matcher.rs @@ -14,6 +14,8 @@ use talpid_types::net::{IpVersion, TransportProtocol, TunnelType}; use super::query::{OpenVpnRelayQuery, RelayQuery, WireguardRelayQuery}; +/// The relay matcher decomposes a [`RelayQuery`] and exposes functions for filtering a set of relays +/// to a subset which match the original query. pub struct RelayMatcher { /// Locations allowed to be picked from. In the case of custom lists this may be multiple /// locations. In normal circumstances this contains only 1 location.