docs: methods of Template

KSXGitHub · Oct 6, 2024 · 7167309 · 7167309
1 parent 5bf03c6
commit 7167309
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/src/template.rs b/src/template.rs
@@ -30,6 +30,8 @@ impl<SegmentResultIntoIter, Query> Template<SegmentResultIntoIter, Query>
 where
     SegmentResultIntoIter: IntoIterator,
 {
+    /// Apply the template, and write the resulting segment outputs that implement [`fmt::Display`] to a
+    /// buffer that implements [`fmt::Write`].
     pub fn write_to<Output, Segment, ParseError, RenderOutput, QueryOutput, QueryError, Respond>(
         self,
         output: &mut Output,
@@ -60,6 +62,7 @@ where
         Ok(())
     }
 
+    /// Apply the template, and send the resulting segment outputs to `handle_query_output`.
     fn apply<
         Segment,
         ParseError,

diff --git a/src/template/std_extensions.rs b/src/template/std_extensions.rs
@@ -9,6 +9,7 @@ impl<SegmentResultIntoIter, Query> Template<SegmentResultIntoIter, Query>
 where
     SegmentResultIntoIter: IntoIterator,
 {
+    /// Apply the template, and join the resulting segment outputs together into a [`String`].
     pub fn to_string<Segment, ParseError, RenderOutput, QueryOutput, QueryError, Respond>(
         self,
         respond: Respond,
@@ -24,6 +25,8 @@ where
         Ok(buf)
     }
 
+    /// Apply the template, and write the resulting segment outputs that implement [`fmt::Display`] to a
+    /// writer that implements [`io::Write`].
     pub fn to_writer<Writer, Segment, ParseError, RenderOutput, QueryOutput, QueryError, Respond>(
         self,
         writer: &mut Writer,