]> git.proxmox.com Git - proxmox-backup.git/commitdiff
proxmox-rest-server: improve ApiService docs
authorDietmar Maurer <dietmar@proxmox.com>
Thu, 30 Sep 2021 15:18:47 +0000 (17:18 +0200)
committerDietmar Maurer <dietmar@proxmox.com>
Thu, 30 Sep 2021 15:18:47 +0000 (17:18 +0200)
proxmox-rest-server/src/rest.rs

index bb7d7e05c4bd3e131d44c9afb62caf5cf5c1353c..e65e5d6b1fbd12eeae38fc344fc09a26bf9fde8c 100644 (file)
@@ -139,6 +139,10 @@ impl Service<&tokio::net::UnixStream> for RestServer {
     }
 }
 
+/// Helper [Service] containing the peer Address
+///
+/// The lower level connection [Service] implementation on
+/// [RestServer] extracts the peer address and return an [ApiService].
 pub struct ApiService {
     pub peer: std::net::SocketAddr,
     pub api_config: Arc<ApiConfig>,