Struct Server 

pub struct Server<T> { /* private fields */ }

Controller and completion future for a running server.

Clones can pause, resume, stop, or submit items to the server. Awaiting a Server resolves when the server has stopped.

Implementations

impl<T> Server<T>

pub fn builder() -> ServerBuilder

Creates a network server builder with no application configuration.

pub fn process(&self, item: T) -> Result<(), T>

Submits an item to the worker pool.

Returns the item unchanged if the server is paused or cannot accept it.

pub fn pause(&self) -> impl Future<Output = ()> + use<T>

Pauses processing new items.

For network servers, pending connections may be dropped. Existing connections remain active.

pub fn resume(&self) -> impl Future<Output = ()> + use<T>

Resumes processing new items.

pub fn stop(&self, graceful: bool) -> impl Future<Output = ()> + use<T>

Stops processing new items and shuts down all workers.

If graceful is true, workers are given time to finish active work before they are stopped.

Trait Implementations

impl<T> Clone for Server<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Server<T>

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

Formats the value using the given formatter.

impl<T> Future for Server<T>

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.