Struct axum_server::Server[−][src]

pub struct Server { /* fields omitted */ }

Expand description

Configurable HTTP server, supporting HTTP/1.1 and HTTP2.

Server can conveniently be turned into a TlsServer with related methods.

See main page for HTTP example. See axum_server::tls module for HTTPS example.

Implementations

[src]

impl Server

[src]

pub fn new() -> Self

Create a new Server.

Must bind to an address before calling serve.

[src]

pub fn bind<A, I>(self, addr: A) -> Self where
A: ToSocketAddrs<Iter = I> + Send + 'static,
I: Iterator<Item = SocketAddr> + 'static,

Bind to a single address or multiple addresses.

[src]

pub fn bind_rustls<A, I>(self, addr: A) -> TlsServer where
A: ToSocketAddrs<Iter = I> + Send + 'static,
I: Iterator<Item = SocketAddr> + 'static,

This is supported on crate feature tls-rustls only.

Bind to a single address or multiple addresses. Using tls protocol on streams.

Certificate and private key must be set before or after calling this.

[src]

pub fn loader(self, config: TlsLoader) -> TlsServer

This is supported on crate feature tls-rustls only.

Provide a loaded TlsLoader.

This will overwrite any previously set private key and certificate(s) with its own ones.

[src]

pub fn tls_config(self, config: Arc<ServerConfig>) -> TlsServer

This is supported on crate feature tls-rustls only.

Provide ServerConfig containing private key and certificate(s).

When this value is set, other tls configurations are ignored.

Successive calls will overwrite last value.

[src]

pub fn private_key(self, key: Vec<u8>) -> TlsServer

This is supported on crate feature tls-rustls only.

Set private key in PEM format.

Successive calls will overwrite last private key.

[src]

pub fn certificate(self, cert: Vec<u8>) -> TlsServer

This is supported on crate feature tls-rustls only.

Set certificate(s) in PEM format.

Successive calls will overwrite last certificate.

[src]

pub fn private_key_file(self, path: impl AsRef<Path>) -> TlsServer

This is supported on crate feature tls-rustls only.

Set private key from file in PEM format.

Successive calls will overwrite last private key.

[src]

pub fn certificate_file(self, path: impl AsRef<Path>) -> TlsServer

This is supported on crate feature tls-rustls only.

Set certificate(s) from file in PEM format.

Successive calls will overwrite last certificate.

[src]

pub fn handle(self, handle: Handle) -> Self

Provide a Handle.

Successive calls will overwrite last Handle.

[src]

pub async fn serve<S, B>(self, service: S) -> Result<()> where
 S: Service<Request<Body>, Response = Response> + Send + Sync + Clone + 'static,
 S::Error: Into<Box<dyn Error + Send + Sync>>,
 S::Future: Send,
 B: Body + Send + 'static,
 B::Data: Send,
 B::Error: Into<Box<dyn Error + Send + Sync>>,

Serve provided cloneable service on all binded addresses.

If accepting connection fails in any one of binded addresses, listening in all binded addresses will be stopped and then an error will be returned.

[src]

pub async fn serve_and_record<S, B>(self, service: S) -> Result<()> where
 S: Service<Request<Body>, Response = Response> + Send + Sync + Clone + 'static,
 S::Error: Into<Box<dyn Error + Send + Sync>>,
 S::Future: Send,
 B: Body + Send + 'static,
 B::Data: Send,
 B::Error: Into<Box<dyn Error + Send + Sync>>,

This is supported on crate feature record only.

Serve provided cloneable service on all binded addresses.

Record sent and received bytes for each connection independently. Sent and received bytes through a connection can be accessed through Request extensions.

See axum_server::record module for examples.

If accepting connection fails in any one of binded addresses, listening in all binded addresses will be stopped and then an error will be returned.

Trait Implementations

[src]

impl Default for Server

[src]

fn default() -> Server

Returns the “default value” for a type. Read more

[src]

impl From<Server> for TlsServer

This is supported on crate feature tls-rustls only.

[src]

fn from(server: Server) -> Self

Performs the conversion.

Auto Trait Implementations

impl !RefUnwindSafe for Server

impl Send for Server

impl !Sync for Server

impl Unpin for Server

impl !UnwindSafe for Server

Blanket Implementations

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T> Instrument for T

[src]

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

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

[src]

fn in_current_span(self) -> Instrumented<Self>

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

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct axum_server::Server[−][src]

Implementations

impl Server

pub fn new() -> Self

pub fn bind<A, I>(self, addr: A) -> Self where A: ToSocketAddrs<Iter = I> + Send + 'static, I: Iterator<Item = SocketAddr> + 'static,

pub fn bind_rustls<A, I>(self, addr: A) -> TlsServer where A: ToSocketAddrs<Iter = I> + Send + 'static, I: Iterator<Item = SocketAddr> + 'static,

pub fn loader(self, config: TlsLoader) -> TlsServer

pub fn tls_config(self, config: Arc<ServerConfig>) -> TlsServer

pub fn private_key(self, key: Vec<u8>) -> TlsServer

pub fn certificate(self, cert: Vec<u8>) -> TlsServer

pub fn private_key_file(self, path: impl AsRef<Path>) -> TlsServer

pub fn certificate_file(self, path: impl AsRef<Path>) -> TlsServer

pub fn handle(self, handle: Handle) -> Self

pub async fn serve<S, B>(self, service: S) -> Result<()> where S: Service<Request<Body>, Response = Response<B>> + Send + Sync + Clone + 'static, S::Error: Into<Box<dyn Error + Send + Sync>>, S::Future: Send, B: Body + Send + 'static, B::Data: Send, B::Error: Into<Box<dyn Error + Send + Sync>>,

Trait Implementations

impl Default for Server

fn default() -> Server

impl From<Server> for TlsServer

fn from(server: Server) -> Self

Auto Trait Implementations

impl !RefUnwindSafe for Server

impl Send for Server

impl !Sync for Server

impl Unpin for Server

impl !UnwindSafe for Server

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

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

type Error = Infallible

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

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

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

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

pub fn bind<A, I>(self, addr: A) -> Self where
A: ToSocketAddrs<Iter = I> + Send + 'static,
I: Iterator<Item = SocketAddr> + 'static,

pub fn bind_rustls<A, I>(self, addr: A) -> TlsServer where
A: ToSocketAddrs<Iter = I> + Send + 'static,
I: Iterator<Item = SocketAddr> + 'static,

pub async fn serve<S, B>(self, service: S) -> Result<()> where
S: Service<Request<Body>, Response = Response<B>> + Send + Sync + Clone + 'static,
S::Error: Into<Box<dyn Error + Send + Sync>>,
S::Future: Send,
B: Body + Send + 'static,
B::Data: Send,
B::Error: Into<Box<dyn Error + Send + Sync>>,

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

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

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

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

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

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