Struct TlsListener

pub struct TlsListener<State> { /* private fields */ }

The primary type for this crate

Implementations

impl<State> TlsListener<State>

pub fn build() -> TlsListenerBuilder<State>

The primary entrypoint to create a TlsListener. See TlsListenerBuilder for more configuration options.

Example

let listener = TlsListener::<()>::build()
    .addrs("localhost:4433")
    .cert("./tls/localhost-4433.cert")
    .key("./tls/localhost-4433.key")
    .finish();

Examples found in repository

examples/hello_tls.rs (line 21)

fn main() -> std::io::Result<()> {
    async_std::task::block_on(async {
        let mut app = tide::new();
        app.at("*").all(endpoint);
        app.at("/").all(endpoint);

        if let (Ok(cert), Ok(key)) = (env::var("TIDE_CERT"), env::var("TIDE_KEY")) {
            app.listen(
                TlsListener::build()
                    .addrs("localhost:4433")
                    .cert(cert)
                    .key(key),
            )
            .await?;
        } else {
            eprintln!(
                "
To run this app locally:
* install https://github.com/FiloSottile/mkcert
* $ mkcert -key-file key.pem -cert-file cert.pem localhost 127.0.0.1 ::1
* $ env TIDE_CERT=cert.pem TIDE_KEY=key.pem cargo run --example hello_tls
* $ curl -v https://localhost:4433/secure
"
            );
        }

        Ok(())
    })
}

Trait Implementations

impl<State> Debug for TlsListener<State>

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

Formats the value using the given formatter.

impl<State> Display for TlsListener<State>

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

Formats the value using the given formatter.

impl<State: Clone + Send + Sync + 'static> Listener<State> for TlsListener<State>

fn bind<'life0, 'async_trait>( &'life0 mut self, server: Server<State>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Bind the listener. This starts the listening process by opening the necessary network ports, but not yet accepting incoming connections. This method must be called before accept.

fn accept<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Start accepting incoming connections. This method must be called only after bind has succeeded.

fn info(&self) -> Vec<ListenInfo>

Expose information about the connection. This should always return valid data after bind has succeeded.

impl<State: Clone + Send + Sync + 'static> ToListener<State> for TlsListener<State>

type Listener = TlsListener<State>

What listener are we converting into?

fn to_listener(self) -> Result<Self::Listener>

Transform self into a Listener. Unless self is already bound/connected to the underlying io, converting to a listener does not initiate a connection. An Err return indicates an unsuccessful conversion to a listener, not an unsuccessful bind attempt.