Struct kvarn::PortDescriptor

source · [−]

pub struct PortDescriptor { /* private fields */ }

Expand description

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

source

impl PortDescriptor

Creation and configuration.

Used when creating a server.

source

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

Uses the defaults for non-secure HTTP with host_data

source

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().

source

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.

source

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.

source

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.

source

pub fn ipv4_only(self) -> Self

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

This disables IPv6 for this port.

source

pub fn ipv6_only(self) -> Self

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

This disables IPv4 for this port.

source

impl PortDescriptor

Inspection.

Used in ctl::Plugins.

source

pub fn port(&self) -> u16

Get the port this description is associated with.

source

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

Available on crate feature https only.

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

source

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.

source

pub fn internet_protocol(&self) -> BindIpVersion

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

Trait Implementations

source

impl Clone for PortDescriptor

source

fn clone(&self) -> PortDescriptor

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for PortDescriptor

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl !RefUnwindSafe for PortDescriptor

impl Send for PortDescriptor

impl Sync for PortDescriptor

impl Unpin for PortDescriptor

impl !UnwindSafe for PortDescriptor

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T> AsTaggedExplicit<'a> for T where
T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self>

impl<'a, T> AsTaggedImplicit<'a> for T where
T: 'a,

fn implicit(
 self,
 class: Class,
 constructed: bool,
 tag: u32
) -> TaggedParser<'a, Implicit, Self>

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;` where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct kvarn::PortDescriptor

Implementations

impl PortDescriptor

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

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

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

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

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

pub fn ipv4_only(self) -> Self

pub fn ipv6_only(self) -> Self

impl PortDescriptor

pub fn port(&self) -> u16

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

pub fn hosts(&self) -> &HostCollection

pub fn internet_protocol(&self) -> BindIpVersion

Trait Implementations

impl Clone for PortDescriptor

fn clone(&self) -> PortDescriptor

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

impl Debug for PortDescriptor

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

Auto Trait Implementations

impl !RefUnwindSafe for PortDescriptor

impl Send for PortDescriptor

impl Sync for PortDescriptor

impl Unpin for PortDescriptor

impl !UnwindSafe for PortDescriptor

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<'a, T> AsTaggedExplicit<'a> for T where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self>

impl<'a, T> AsTaggedImplicit<'a> for T where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32) -> TaggedParser<'a, Implicit, Self>

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output; where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<'a, T> AsTaggedExplicit<'a> for T where
T: 'a,

impl<'a, T> AsTaggedImplicit<'a> for T where
T: 'a,

fn implicit(
self,
class: Class,
constructed: bool,
tag: u32
) -> TaggedParser<'a, Implicit, Self>

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;` where
S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`