Struct Listener 

pub struct Listener(/* private fields */);

A description of one listener a server is bound to.

A Conn carries the Listener it arrived on in its state, and a server exposes the full set on Info at startup, so a runtime-neutral handler can answer both “what is this server listening on?” and “which listener did this request come from?” — to announce every binding at launch, say, or to tag a log line with the ingress a request arrived on.

Cloning is a reference-count bump, so stamping it onto every conn is cheap.

The inner representation is private, so further provenance (e.g. negotiated SNI) can be added in a minor release without a breaking change.

Implementations

impl Listener

pub fn new(kind: ListenerKind, secure: bool) -> Self

Construct a Listener from its kind and whether the listener terminates TLS.

pub fn tcp(addr: SocketAddr, secure: bool) -> Self

Construct a TCP Listener.

pub fn quic(addr: SocketAddr) -> Self

Construct a QUIC/HTTP3 Listener. QUIC is always TLS.

pub fn unix(path: Option<PathBuf>, secure: bool) -> Self

Construct a Unix-domain-socket Listener. The path is None for an unnamed or abstract socket.

pub fn kind(&self) -> &ListenerKind

The kind of listener this describes.

pub fn is_secure(&self) -> bool

Whether this listener terminates TLS. This reflects the listener’s immutable ground truth, not necessarily the view a client sees: a plaintext listener fronted by a TLS-terminating proxy reports false. For the (mutable, possibly forwarding-header-derived) per-request view, see Conn::is_secure.

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

The bound socket address, for listener kinds that have one (Tcp and Quic). None for a Unix socket or an unaddressed kind.

pub fn port(&self) -> Option<u16>

The bound port, for listener kinds that have one.

Trait Implementations

impl Clone for Listener

fn clone(&self) -> Listener

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Listener

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

Formats the value using the given formatter.

impl Display for Listener

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

Formats the value using the given formatter.

impl Eq for Listener

impl FromIterator<Listener> for Listeners

fn from_iter<T: IntoIterator<Item = Listener>>(iter: T) -> Self

Creates a value from an iterator.

impl PartialEq for Listener

fn eq(&self, other: &Listener) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Listener