Struct ConnectionInfo 

#[non_exhaustive]
pub struct ConnectionInfo {

    pub id: ConnectionId,
    pub listener: Option<ListenerId>,
    pub worker: WorkerId,
    pub transport: Transport,
    pub origin: Origin,
    pub local: Endpoint,
    pub peer: Endpoint,
    pub real_peer: Option<SocketAddr>,
    pub proxy: Option<Arc<ProxyFacts>>,
    pub peer_credentials: Option<PeerCredentials>,
    pub tls: Option<Arc<TlsInfo>>,
    pub lane: Lane,
    pub gate: GateTag,
    pub accepted_at: Instant,
}

What net-io knows about one connection, built at accept and completed as the handshake reveals more. It holds no heap memory.

Examples

let info = net_io::ConnectionInfo::for_testing("192.0.2.1:5000".parse().unwrap());
assert_eq!(info.client_addr().unwrap().port(), 5000);
let key = info.client_key(net_io::PrefixPolicy::DEFAULT).unwrap();
assert_eq!(key.to_string(), "192.0.2.1/32");

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: ConnectionId

The connection’s id.

listener: Option<ListenerId>

The listener that accepted it, if any.

worker: WorkerId

The worker that owns it.

transport: Transport

The kind of socket.

origin: Origin

How it came to exist.

local: Endpoint

Our end.

peer: Endpoint

The socket peer, normalized.

real_peer: Option<SocketAddr>

The real client from a trusted PROXY header, normalized.

proxy: Option<Arc<ProxyFacts>>

Facts copied from a trusted PROXY header (pooled per worker, no allocation after warm-up).

peer_credentials: Option<PeerCredentials>

Who is on the other end of a local socket.

tls: Option<Arc<TlsInfo>>

TLS facts after the handshake (pooled per worker, no allocation after warm-up).

lane: Lane

The lane the gate assigned.

gate: GateTag

The gate’s tag for this connection.

accepted_at: Instant

When the connection was accepted or dialed.

Implementations

impl ConnectionInfo

pub fn client_addr(&self) -> Option<SocketAddr>

The client address: the real peer from a trusted PROXY header when set, otherwise the IP peer.

pub fn client_key(&self, policy: PrefixPolicy) -> Option<PrefixKey>

The client address grouped under policy.

pub fn socket_peer(&self) -> Option<SocketAddr>

The socket peer, ignoring any PROXY header.

pub fn for_testing(peer: SocketAddr) -> ConnectionInfo

A connection fact set attached to no socket, for testing gates and sessions.

The id comes from the process counter, so it never collides with a real connection. Fields are public to adjust.

Trait Implementations

impl Clone for ConnectionInfo

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConnectionInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.