Skip to content

Commit 89b5b04

Browse files
committed
docs: update docs about peer_addr when bound to a UDS socket
1 parent e42cffc commit 89b5b04

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

actix-web/src/request.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,8 +264,10 @@ impl HttpRequest {
264264
///
265265
/// For expanded client connection information, use [`connection_info`] instead.
266266
///
267-
/// Will return None when server listens on UDS socket or when called in unit tests unless [`TestRequest::peer_addr`] is used.
267+
/// Will only return `None` when server is listening on [UDS socket] or when called in unit
268+
/// tests unless [`TestRequest::peer_addr`] is used.
268269
///
270+
/// [UDS socket]: crate::HttpServer::bind_uds
269271
/// [`TestRequest::peer_addr`]: crate::test::TestRequest::peer_addr
270272
/// [`connection_info`]: Self::connection_info
271273
#[inline]

0 commit comments

Comments
 (0)