docs(websocket,gateway): fix rustdoc link warnings, restore -D warnings doc gate
- dispatch.rs: qualify [invoke]/[invoke_streaming] as [GatewayDispatch::invoke]/[::invoke_streaming] (module-level docs need the type-qualified path) - byte_adapter.rs: drop redundant explicit link targets for DEFAULT_WS_WRITE_TIMEOUT / DEFAULT_WS_IDLE_TIMEOUT (already re-exported at crate::websocket) - from_wss.rs, byte_adapter.rs: backtick WssSession::drop and the private WsFraming (all-features-only link errors, same class) - Ws pump/timeout module docs spot-checked against WS-13/18/17 impls: no drift found RUSTDOCFLAGS="-D warnings" cargo doc --no-deps now exits clean both default-features and --all-features. docs(tasks): mark review-002-fu-doc-warnings done
This commit is contained in:
@@ -668,7 +668,7 @@ pub fn split_ws_to_bytes_idle(
|
||||
|
||||
/// [`split_ws_to_bytes_idle`] with an explicit WS-18 write-progress
|
||||
/// window: `None` = the crate default
|
||||
/// ([`DEFAULT_WS_WRITE_TIMEOUT`](crate::websocket::DEFAULT_WS_WRITE_TIMEOUT)),
|
||||
/// ([`DEFAULT_WS_WRITE_TIMEOUT`]),
|
||||
/// `Some(d)` a deployment-set window.
|
||||
pub fn split_ws_to_bytes_idle_with_write(
|
||||
socket: WebSocket,
|
||||
@@ -920,7 +920,7 @@ impl WsFraming for TungsteniteFraming {
|
||||
|
||||
/// Client-side split for a tokio-tungstenite `WebSocketStream` with
|
||||
/// the default idle-read timeout
|
||||
/// ([`DEFAULT_WS_IDLE_TIMEOUT`](crate::websocket::DEFAULT_WS_IDLE_TIMEOUT)).
|
||||
/// ([`DEFAULT_WS_IDLE_TIMEOUT`]).
|
||||
/// See [`split_tungstenite_to_bytes_idle`] for the configurable form.
|
||||
#[cfg(any(test, feature = "wss"))]
|
||||
pub fn split_tungstenite_to_bytes<S>(
|
||||
@@ -938,7 +938,7 @@ where
|
||||
/// axum's server-side `WebSocket`. Message semantics are identical:
|
||||
/// binary messages carry the byte stream, text is a protocol error
|
||||
/// (close 1002), close → read EOF. Both paths run the same generic
|
||||
/// pumps (WS-11); the socket flavor differs only in the [`WsFraming`]
|
||||
/// pumps (WS-11); the socket flavor differs only in the `WsFraming`
|
||||
/// impl. `idle_timeout` (WS-01): `None` = no idle bound, `Some(d)`
|
||||
/// closes the read with 1001 after `d` without an inbound WS message.
|
||||
#[cfg(any(test, feature = "wss"))]
|
||||
|
||||
Reference in New Issue
Block a user