Struct LocalServer 

pub struct LocalServer { /* private fields */ }

A running local-flavor server: its bound address + a graceful shutdown switch.

Dropping the handle without calling shutdown signals the server to stop (the shutdown channel closes) and detaches the background task. Call shutdown to stop and await a clean exit.

Implementations

impl LocalServer

pub fn builder() -> LocalServerBuilder

Start building a local-flavor server. See LocalServerBuilder.

pub fn addr(&self) -> SocketAddr

The real address the server bound on — already resolved, so this returns the concrete ephemeral port when the builder asked for port 0.

pub fn ws_url(&self) -> String

The ws://<addr>/ws URL clients connect to.

pub async fn shutdown(self) -> Result<()>

Signal graceful shutdown and await the server task’s clean exit.

Errors

Returns an error if the server task panicked or its serve loop errored.

Trait Implementations

impl Drop for LocalServer

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.