Skip to main content

HttpServerBuilder

Struct HttpServerBuilder 

Source
pub struct HttpServerBuilder { /* private fields */ }
Expand description

Builder for HttpServer.

Implementations§

Source§

impl HttpServerBuilder

Source

pub fn new(config: HttpServerConfig, cancel: CancellationToken) -> Self

Create a new builder.

Source

pub fn with_router(self, router: Router) -> Self

Merge an axum Router into the server.

Source

pub fn with_middleware_stack(self, middleware: HttpMiddlewareStack) -> Self

Replace the ordered middleware stack.

Source

pub fn with_logging_transform<F>(self, transform: F) -> Self
where F: Fn(Router) -> Router + Send + Sync + 'static,

Append a logging-phase transform.

Source

pub fn with_auth_transform<F>(self, transform: F) -> Self
where F: Fn(Router) -> Router + Send + Sync + 'static,

Append an auth-phase transform.

Source

pub fn with_validation_transform<F>(self, transform: F) -> Self
where F: Fn(Router) -> Router + Send + Sync + 'static,

Append a validation-phase transform.

Source

pub fn with_metrics_transform<F>(self, transform: F) -> Self
where F: Fn(Router) -> Router + Send + Sync + 'static,

Append a metrics-phase transform.

Source

pub fn with_cors(self) -> AppResult<Self>

Apply CORS from the server config (no-op if cors is None).

§Errors

Returns an error when the configured CORS policy contains invalid origins, methods, headers, or max-age values.

Source

pub fn with_request_id(self) -> Self

Add automatic X-Request-Id injection.

Source

pub fn with_security_headers(self) -> AppResult<Self>

Add secure response headers using the default security policy.

§Errors

Returns an error if the default security policy cannot be built (should never happen in practice — this is a programming error guard).

Source

pub fn with_security_headers_config( self, config: SecurityHeadersConfig, ) -> AppResult<Self>

Add secure response headers using an explicit security policy.

§Errors

Returns an error when the supplied policy is invalid.

Source

pub fn with_tracing(self) -> Self

Add the canonical tracing phase.

Tracing is owned by build so this remains a compatibility no-op.

Source

pub fn build(self) -> AppResult<HttpServer>

Consume the builder and produce an HttpServer.

§Errors

Returns an error when baseline transport middleware configuration is invalid.

Source

pub fn with_body_limit(self) -> Self

Add the configured request body limit.

Source

pub fn with_timeout(self) -> Self

Add the configured request timeout.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more