actix/actix-web
1
0
Fork 0
mirror of https://github.com/fafhrd91/actix-web synced 2025-06-09 16:05:20 +02:00
Code Issues Releases Wiki Activity

docs: update docs about peer_addr when bound to a UDS socket

Browse Source
This commit is contained in:
Rob Ede 2025-05-10 02:23:22 +01:00
parent e42cffc28d
commit 89b5b04653
No known key found for this signature in database
GPG Key ID: 97C636207D3EF933
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
actix-web/src/request.rs
View File

@ -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]