From: Dietmar Maurer <dietmar@proxmox.com>
Date: Thu, 30 Sep 2021 15:18:47 +0000 (+0200)
Subject: proxmox-rest-server: improve ApiService docs
X-Git-Tag: v2.0.12~44
X-Git-Url: https://git.proxmox.com/?a=commitdiff_plain;h=2194bc59c8300d626198c721bed270a45386c90f;p=proxmox-backup.git

proxmox-rest-server: improve ApiService docs
---

diff --git a/proxmox-rest-server/src/rest.rs b/proxmox-rest-server/src/rest.rs
index bb7d7e05..e65e5d6b 100644
--- a/proxmox-rest-server/src/rest.rs
+++ b/proxmox-rest-server/src/rest.rs
@@ -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>,