Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/app.rs
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ pub struct PacketParts {
payload: Vec<u8>,
}

/// Basic envelope type used by [`handle_connection`].
/// Basic envelope type used by [`WireframeApp::handle_connection`].
///
/// Incoming frames are deserialized into an `Envelope` containing the
/// message identifier and raw payload bytes.
Expand Down Expand Up @@ -425,7 +425,7 @@ where

/// Store a shared state value accessible to request extractors.
///
/// The value can later be retrieved using [`SharedState<T>`]. Registering
/// The value can later be retrieved using [`crate::extractor::SharedState`]. Registering
/// another value of the same type overwrites the previous one.
#[must_use]
pub fn app_data<T>(mut self, state: T) -> Self
Expand Down
2 changes: 1 addition & 1 deletion src/extractor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ use crate::message::Message as WireMessage;
/// Request context passed to extractors.
///
/// This type contains metadata about the current connection and provides
/// access to application state registered with [`WireframeApp`].
/// access to application state registered with [`crate::app::WireframeApp`].
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (review_instructions): The module does not begin with a //! comment as required by the instructions.

Please add a //! module-level comment at the top of this file to describe its purpose and usage.

Review instructions:

Path patterns: **/*.rs

Instructions:
Every module must begin with a //! comment.

#[derive(Default)]
pub struct MessageRequest {
/// Address of the peer that sent the current message.
Expand Down
2 changes: 1 addition & 1 deletion src/hooks.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ pub trait WireframeProtocol: Send + Sync + 'static {
/// Invoked when a request/response cycle completes.
fn on_command_end(&self, _ctx: &mut ConnectionContext) {}

/// Called when a handler returns a [`WireframeError::Protocol`].
/// Called when a handler returns a [`crate::WireframeError::Protocol`].
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (review_instructions): The module does not begin with a //! comment as required by the instructions.

Please add a //! module-level comment at the top of this file to describe its purpose and usage.

Review instructions:

Path patterns: **/*.rs

Instructions:
Every module must begin with a //! comment.

///
/// ```no_run
/// use wireframe::{ConnectionContext, WireframeProtocol};
Expand Down
2 changes: 1 addition & 1 deletion src/push.rs
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ impl<T> FrameLike for T where T: Send + 'static {}
/// Default maximum pushes allowed per second when no custom rate is specified.
const DEFAULT_PUSH_RATE: usize = 100;
/// Highest supported rate for [`PushQueues::bounded_with_rate`].
const MAX_PUSH_RATE: usize = 10_000;
pub const MAX_PUSH_RATE: usize = 10_000;
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (review_instructions): The module does not begin with a //! comment as required by the instructions.

Please add a //! module-level comment at the top of this file to describe its purpose and usage.

Review instructions:

Path patterns: **/*.rs

Instructions:
Every module must begin with a //! comment.


/// Priority level for outbound messages.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
Expand Down
2 changes: 1 addition & 1 deletion src/server/config/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ where
/// this cannot be determined). The server is initially [`Unbound`]; call
/// [`bind`](WireframeServer::bind) or
/// [`bind_existing_listener`](WireframeServer::bind_existing_listener)
/// (methods provided by the [`binding`](self::binding) module) before running the server.
/// (methods provided by the [`binding`] module) before running the server.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (review_instructions): The module does not begin with a //! comment as required by the instructions.

Please add a //! module-level comment at the top of this file to describe its purpose and usage.

Review instructions:

Path patterns: **/*.rs

Instructions:
Every module must begin with a //! comment.

///
/// # Examples
///
Expand Down
2 changes: 1 addition & 1 deletion src/server/error.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! Errors raised by [`WireframeServer`] operations.
//! Errors raised by [`super::WireframeServer`] operations.

use std::io;

Expand Down
4 changes: 2 additions & 2 deletions src/server/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ pub type PreambleErrorHandler = Arc<dyn Fn(&DecodeError) + Send + Sync + 'static
///
/// The server carries a typestate `S` indicating whether it is
/// [`Unbound`] (not yet bound to a TCP listener) or [`Bound`]. New
/// servers start `Unbound` and must call [`binding::WireframeServer::bind`] or
/// [`binding::WireframeServer::bind_existing_listener`] before running. A worker task is spawned
/// servers start `Unbound` and must call [`WireframeServer::bind`] or
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (review_instructions): The module does not begin with a //! comment as required by the instructions.

Please add a //! module-level comment at the top of this file to describe its purpose and usage.

Review instructions:

Path patterns: **/*.rs

Instructions:
Every module must begin with a //! comment.

/// [`WireframeServer::bind_existing_listener`] before running. A worker task is spawned
/// per thread; each receives its own `WireframeApp` from the provided factory
/// closure. The server listens for a shutdown signal using
/// `tokio::signal::ctrl_c` and notifies all workers to stop accepting new
Expand Down
4 changes: 2 additions & 2 deletions src/session.rs
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ impl<F: FrameLike> SessionRegistry<F> {

/// Prune stale weak references, then collect the remaining live handles.
///
/// This method mutates the registry. Use [`prune`] from a maintenance task
/// This method mutates the registry. Use [`Self::prune`] from a maintenance task
/// to clean up without collecting handles. `DashMap::retain` holds
/// per-bucket write locks while iterating.
#[must_use]
Expand All @@ -92,7 +92,7 @@ impl<F: FrameLike> SessionRegistry<F> {

/// Prune stale weak references, then return the IDs of the live connections.
///
/// This method mutates the registry. Use [`prune`] from a maintenance task
/// This method mutates the registry. Use [`Self::prune`] from a maintenance task
/// to clean up without collecting handles. `DashMap::retain` holds
/// per-bucket write locks while iterating.
#[must_use]
Expand Down
Loading