Note explicitly that Request::Unknown has no reply parser.

psychon · Jun 11, 2020 · d637156 · d637156
1 parent 74a1785
commit d637156
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/generator/src/generator/namespace.rs b/generator/src/generator/namespace.rs
@@ -156,8 +156,9 @@ pub(super) fn generate_request_reply_enum(
         outln!(out, "}}");
         outln!(
             out,
-            "// Get the matching reply parser (if any) for this request"
+            "/// Get the matching reply parser (if any) for this request"
         );
+        outln!(out, "/// For `Request::Unknown`, `None` is also returned.");
         outln!(
             out,
             "pub fn reply_parser(&self) -> Option<ReplyParsingFunction> {{"

diff --git a/src/protocol/mod.rs b/src/protocol/mod.rs
@@ -2110,7 +2110,8 @@ impl<'input> Request<'input> {
         }
         Ok(Request::Unknown(header, remaining))
     }
-    // Get the matching reply parser (if any) for this request
+    /// Get the matching reply parser (if any) for this request
+    /// For `Request::Unknown`, `None` is also returned.
     pub fn reply_parser(&self) -> Option<ReplyParsingFunction> {
         match self {
             Request::Unknown(_, _) => None,