docs: Add rustdoc comments for functions, structs, and traits

Co-authored-by: aider (openai/andrew/openrouter/sonoma-sky-alpha) <aider@aider.chat>
This commit is contained in:
Andrew Phillips
2025-09-10 10:52:31 -03:00
parent ec4dfed2be
commit 25b99b938e
6 changed files with 415 additions and 60 deletions

View File

@@ -14,6 +14,10 @@ impl HeadBytesFilter {
/// # Arguments
///
/// * `count` - The maximum number of bytes to read from the input.
///
/// # Returns
///
/// A new instance of `HeadBytesFilter`.
pub fn new(count: usize) -> Self {
Self {
remaining: count,
@@ -88,6 +92,10 @@ impl HeadLinesFilter {
/// # Arguments
///
/// * `count` - The maximum number of lines to read from the input.
///
/// # Returns
///
/// A new instance of `HeadLinesFilter`.
pub fn new(count: usize) -> Self {
Self {
remaining: count,