tonic/transport/server/unix.rs
1/*
2 *
3 * Copyright 2025 gRPC authors.
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to
7 * deal in the Software without restriction, including without limitation the
8 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
9 * sell copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21 * IN THE SOFTWARE.
22 *
23 */
24
25use super::Connected;
26use std::sync::Arc;
27
28/// Connection info for Unix domain socket streams.
29///
30/// This type will be accessible through [request extensions][ext] if you're using
31/// a unix stream.
32///
33/// See [Connected] for more details.
34///
35/// [ext]: crate::Request::extensions
36#[derive(Clone, Debug)]
37pub struct UdsConnectInfo {
38 /// Peer address. This will be "unnamed" for client unix sockets.
39 pub peer_addr: Option<Arc<tokio::net::unix::SocketAddr>>,
40 /// Process credentials for the unix socket.
41 pub peer_cred: Option<tokio::net::unix::UCred>,
42}
43
44impl Connected for tokio::net::UnixStream {
45 type ConnectInfo = UdsConnectInfo;
46
47 fn connect_info(&self) -> Self::ConnectInfo {
48 UdsConnectInfo {
49 peer_addr: self.peer_addr().ok().map(Arc::new),
50 peer_cred: self.peer_cred().ok(),
51 }
52 }
53}