Enum ServerFuture

pub enum ServerFuture {
    Init {
        server: Server,
        enable_signal: bool,
    },
    Running(ServerFutureInner),
    Error(Error),
    Finished,
}

Variants

Init

Fields

server: Server

enable_signal: bool

Running(ServerFutureInner)

Error(Error)

Finished

Implementations

impl ServerFuture

pub fn handle(&mut self) -> Result<ServerHandle>

A handle for mutate Server state.

Examples:

let mut server = Builder::new()
    .bind("test", "127.0.0.1:0", fn_service(|_io: TcpStream| async { Ok::<_, ()>(())}))
    .unwrap()
    .build();

// obtain a handle. if server fail to start a std::io::Error would return.
let handle = server.handle().unwrap();

// spawn server future.
tokio::spawn(server);

// do a graceful shutdown of server.
handle.stop(true);

pub fn wait(self) -> Result<()>

Consume ServerFuture and block current thread waitting for server stop.

Server can be stopped through OS signal or ServerHandle::stop. If none is active this call would block forever.

Trait Implementations

impl Default for ServerFuture

fn default() -> Self

Returns the “default value” for a type.

impl Future for ServerFuture

type Output = Result<(), Error>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.