proxmox-rest-server: improve ApiService docs

This commit is contained in:
Dietmar Maurer 2021-09-30 17:18:47 +02:00
parent a98a288e2d
commit 2194bc59c8
1 changed files with 4 additions and 0 deletions

View 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 struct ApiService {
pub peer: std::net::SocketAddr, pub peer: std::net::SocketAddr,
pub api_config: Arc<ApiConfig>, pub api_config: Arc<ApiConfig>,