Struct tide::listener::FailoverListener

pub struct FailoverListener<State>(_);

FailoverListener allows tide to attempt to listen in a sequential order to any number of ports/addresses. The first successful listener is used.

Example:

fn main() -> Result<(), std::io::Error> {
   async_std::task::block_on(async {
       tide::log::start();
       let mut app = tide::new();
       app.at("/").get(|_| async { Ok("Hello, world!") });

       let mut listener = tide::listener::FailoverListener::new();
       listener.add("127.0.0.1:8000")?;
       listener.add(async_std::net::TcpListener::bind("127.0.0.1:8001").await?)?;
       listener.add("http+unix://unix.socket")?;
   
       app.listen(listener).await?;
       Ok(())
   })
}

Implementations

impl<State: Clone + Send + Sync + 'static> FailoverListener<State>

pub fn new() -> Self

creates a new FailoverListener

pub fn add<TL: ToListener<State>>(&mut self, listener: TL) -> Result<()>

Adds any ToListener to this FailoverListener. An error result represents a failure to convert the ToListener into a Listener.

let mut listener = tide::listener::FailoverListener::new();
listener.add("127.0.0.1:8000")?;
listener.add(("localhost", 8001))?;
listener.add("http+unix:///var/run/tide")?;

pub fn with_listener<TL: ToListener<State>>(self, listener: TL) -> Self

FailoverListener::with_listener allows for chained construction of a FailoverListener:

app.listen(
    FailoverListener::new()
        .with_listener("127.0.0.1:8080")
        .with_listener(("localhost", 8081)),
).await?;

Trait Implementations

impl<State> Debug for FailoverListener<State>

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

Formats the value using the given formatter.

impl<State: Default> Default for FailoverListener<State>

fn default() -> FailoverListener<State>

Returns the "default value" for a type.

impl<State> Display for FailoverListener<State>

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

Formats the value using the given formatter.

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

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

This is the primary entrypoint for the Listener trait. listen is called exactly once, and is expected to spawn tasks for each incoming connection.

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

type Listener = Self

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.