Struct RestServer 

pub struct RestServer { /* private fields */ }

Assembles and runs an Actix server with rust-zero’s standard production middleware.

Implementations

impl RestServer

pub fn new(config: RestServerConfig) -> Result<Self, RestServerConfigError>

pub fn with_metrics( config: RestServerConfig, metrics: Arc<Metrics>, ) -> Result<Self, RestServerConfigError>

pub fn with_static_assets(self, static_assets: StaticAssets) -> Self

Installs an opt-in static-directory and/or embedded-asset fallback.

pub fn with_route_middleware<M>( self, name: impl Into<String>, middleware: M, ) -> Result<Self, RestServerConfigError>

where M: RouteMiddleware,

Registers application middleware referenced by declarative route groups.

pub fn with_response_policy(self, response_policy: ResponsePolicy) -> Self

Installs the response policy as Actix application data for all registered handlers.

pub fn with_content_encryption( self, content_encryption: ContentEncryption, ) -> Self

Enables authenticated request decryption and buffered response encryption.

Install this only for APIs whose clients implement the versioned content-encryption wire format. Streaming routes such as SSE must remain on a server without this middleware.

pub fn config(&self) -> &RestServerConfig

pub fn metrics(&self) -> Arc<Metrics>

pub fn response_policy(&self) -> &ResponsePolicy

pub async fn serverless_handler<F>( &self, configure: F, ) -> Result<ServerlessHandler, RestServerConfigError>

where F: FnOnce(&mut ServiceConfig) + 'static,

Builds a reusable socket-free handler with the same routes, policies, middleware, and static fallback as RestServer::run.

pub fn run<F>(&self, configure: F) -> Result<Server>

where F: Fn(&mut ServiceConfig) + Clone + Send + 'static,

Binds the configured listener and installs the standard stack around application routes.

The configure callback is cloned per Actix worker and can register ordinary routes, resources, and scoped route groups.

pub fn run_on<F>(&self, listener: TcpListener, configure: F) -> Result<Server>

where F: Fn(&mut ServiceConfig) + Clone + Send + 'static,

Runs the configured stack on an existing listener.

Supplying the listener is useful for socket activation and lets tests reserve an ephemeral port without a bind race.

pub async fn serve_until<C, F>(&self, configure: C, shutdown: F) -> Result<()>

where C: Fn(&mut ServiceConfig) + Clone + Send + 'static, F: Future<Output = ()>,

Serves until the supplied shutdown signal resolves, then gracefully drains requests.

pub async fn serve_on_until<C, F>( &self, listener: TcpListener, configure: C, shutdown: F, ) -> Result<()>

where C: Fn(&mut ServiceConfig) + Clone + Send + 'static, F: Future<Output = ()>,

Listener-based variant of RestServer::serve_until.

Trait Implementations

impl Clone for RestServer

fn clone(&self) -> RestServer

Returns a duplicate of the value.

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

Performs copy-assignment from source.