From 89b5b046539dcfe4fd72f0b7a54979cbaf0d8f22 Mon Sep 17 00:00:00 2001 From: Rob Ede Date: Sat, 10 May 2025 02:23:22 +0100 Subject: [PATCH] docs: update docs about peer_addr when bound to a UDS socket --- actix-web/src/request.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/actix-web/src/request.rs b/actix-web/src/request.rs index 32803ce45..a49a55bd0 100644 --- a/actix-web/src/request.rs +++ b/actix-web/src/request.rs @@ -264,8 +264,10 @@ impl HttpRequest { /// /// For expanded client connection information, use [`connection_info`] instead. /// - /// Will return None when server listens on UDS socket or when called in unit tests unless [`TestRequest::peer_addr`] is used. + /// Will only return `None` when server is listening on [UDS socket] or when called in unit + /// tests unless [`TestRequest::peer_addr`] is used. /// + /// [UDS socket]: crate::HttpServer::bind_uds /// [`TestRequest::peer_addr`]: crate::test::TestRequest::peer_addr /// [`connection_info`]: Self::connection_info #[inline]