📝 Add docstrings to codex/standardise-trait-definitions-for-frameprocessor

[coderabbitai]

Docstrings generation was requested by @leynos.

• Implement trait foundations #8 (comment)

The following files were modified:

• src/extractor.rs
• src/middleware.rs
• src/server.rs

These file types are not supported

• Cargo.toml
• docs/roadmap.md
• docs/rust-binary-router-library-design.md

ℹ️ Note

CodeRabbit cannot perform edits on its own pull requests yet.

Summary by Sourcery

Add comprehensive docstrings with usage examples to core methods and types across extractor, middleware, and server modules

Enhancements:

• Add detailed doc comments and examples to Payload.advance in extractor.rs
• Add documentation and example for Payload.remaining in extractor.rs
• Add docstrings with examples for SharedState.new and Deref implementation in extractor.rs tests
• Add description and usage examples for WireframeServer.workers in server.rs
• Add documentation and examples for Next::new constructor in middleware.rs
• Add doc comments and example usage for Next::call in middleware.rs

[sourcery-ai]

Reviewer's Guide

This PR adds comprehensive docstrings and illustrative examples to key public methods in extractor.rs, server.rs, and middleware.rs to improve clarity and documentation consistency.

Class diagram for Payload

classDiagram
    class Payload {
        +data: &'a [u8]
        +advance(count: usize)
        +remaining() usize
    }

Loading

Class diagram for SharedState<T>

classDiagram
    class SharedState~T~ {
        -inner: Arc~T~
        +new(inner: Arc~T~) Self
        +deref() &T
    }

Loading

Class diagram for Next<'a, S>

classDiagram
    class Next~'a, S~ {
        -service: &'a S
        +new(service: &'a S) Self
        +call(req: ServiceRequest) Result~ServiceResponse, S_Error~
    }

Loading

Class diagram for WireframeServer<F, S>

classDiagram
    class WireframeServer~F, S~ {
        -workers: usize
        +workers(count: usize) Self
    }

Loading

File-Level Changes

Change	Details	Files
Enhanced docstrings for payload and shared state utilities	Clarified advance() behaviour when count exceeds buffer and added usage examples Added examples and detailed description for remaining() Documented SharedState::new() with examples Documented Deref impl for SharedState with examples	src/extractor.rs
Documented server builder’s worker configuration	Described workers() method behaviour and defaulting logic Provided short and extended usage examples for setting worker count	src/server.rs
Added docstrings to middleware Next helper	Documented Next::new() with example Described async call() method flow and provided example usage	src/middleware.rs

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[coderabbitai]

Important

Review skipped

CodeRabbit bot authored PR detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.