Clarify note on "none" transport ID.

2022-09-23 17:36:07 +00:00 · 2022-09-23 17:36:07 +00:00 · 9df8ea215a
parent e412d7400c
commit 9df8ea215a
1 changed files with 3 additions and 0 deletions
--- a/crates/tor-linkspec/src/transport.rs
+++ b/crates/tor-linkspec/src/transport.rs
@ -29,6 +29,9 @@ enum Inner {
 }

 /// This identifier is used to indicate the built-in transport.
+//
+// Actual pluggable transport names are restricted to the syntax of C identifiers.
+// This string deliberately is not in that syntax so as to avoid clashes.
 const BUILT_IN_ID: &str = "<none>";

 impl std::str::FromStr for TransportId {