Struct PortDescriptor

pub struct PortDescriptor { /* private fields */ }

Describes port, certificate, and host data for a single port to bind.

See the note at the bottom of Host for an explanation about the relationship between Self::new and Self::unsecure.

Implementations

impl PortDescriptor

Creation and configuration.

Used when creating a server.

pub fn http(host_data: Arc<HostCollection>) -> Self

Uses the defaults for non-secure HTTP with host_data

pub fn https(host_data: Arc<HostCollection>) -> Self

Available on crate feature https only.

Uses the defaults for secure HTTP, HTTPS, with host_data. Gets a [rustls::ServerConfig] from HostCollection::make_config().

pub fn with_server_config( port: u16, host_data: Arc<HostCollection>, server_config: Option<Arc<ServerConfig>>, ) -> Self

Available on crate feature https only.

Creates a new descriptor for port with host_data and an optional [rustls::ServerConfig].

pub fn new(port: u16, host_data: Arc<HostCollection>) -> Self

Creates a new descriptor for port with host_data. If the feature https is enabled, a rustls::ServerConfig is created from the host_data.

pub fn unsecure(port: u16, host_data: Arc<HostCollection>) -> Self

Creates a new non-secure descriptor for port with host_data. Does not try to assign a certificate.

pub fn ipv4_only(self) -> Self

Binds to IPv4 only. The default is to bind both.

This disables IPv6 for this port.

pub fn ipv6_only(self) -> Self

Binds to IPv6 only. The default is to bind both.

This disables IPv4 for this port.

impl PortDescriptor

Inspection.

Used in ctl::Plugins.

pub fn port(&self) -> u16

Get the port this description is associated with.

pub fn tls_config(&self) -> Option<&ServerConfig>

Available on crate feature https only.

Get a reference to this port’s optional TLS config.

pub fn hosts(&self) -> &HostCollection

Get the associated hosts.

This can be used to remove entries from the response & file cache.

Remember, this collection can be the same as for any other port descriptor.

pub fn internet_protocol(&self) -> BindIpVersion

Get the version of the internet protocol (IP) we are listening on through Self::port.

Trait Implementations

impl Clone for PortDescriptor

fn clone(&self) -> PortDescriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PortDescriptor

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

Formats the value using the given formatter.