Skip to main content

rl_lang/docs/entries/stdlib/net/
tcp_peer_addr.rs

1use crate::docs::entry::FnEntry;
2
3pub static TCP_PEER_ADDR: FnEntry = FnEntry {
4    signature: "tcp_peer_addr(stream)",
5    description: "returns the remote address of a connected TCP stream",
6    example: r#"
7get std::net::tcp_peer_addr
8
9tcp_peer_addr(stream)"#,
10    expected_output: None,
11    returns: "Result[string]",
12    errors: Some("Err(string) if the stream has no peer address available"),
13    see_also: &["tcp_local_addr"],
14    since: Some("v0.1.5"),
15};