Skip to main content

Host

Struct Host 

Source
pub struct Host {
    pub options: AppOptions,
    /* private fields */
}

Fields§

§options: AppOptions

Implementations§

Source§

impl Host

Source

pub fn builder() -> HostBuilder

Source

pub fn options(&self) -> &AppOptions

Source

pub async fn run(&self) -> Result<()>

Start the server on all URLs configured in AppOptions.app.Urls.

Automatically detects http:// and https:// URLs from the array. Starts a plain TCP listener for each http:// URL and a TLS listener for each https:// URL. All listeners run concurrently.

Supports graceful shutdown on Ctrl+C/SIGTERM with 30s connection drain.

§Example
{ "App": { "Urls": ["http://localhost:5000", "https://localhost:5030"] } }
Source

pub async fn run_at(&self, addr: &str) -> Result<()>

Start the server at a single explicit address (convenience wrapper).

Source

pub fn server_handle(&self) -> ServerHandle

Return a ServerHandle that can be used to signal graceful shutdown from application code (e.g., integration tests, health checks).

let host = Host::builder().build();
let handle = host.server_handle();
tokio::spawn(async move { host.run().await });
// ... later:
handle.shutdown();
Source

pub fn into_server(self) -> Server

Consume the host and return a Server that owns the runtime lifecycle.

The returned Server can be .run().await-ed and provides a handle for graceful shutdown.

Trait Implementations§

Source§

impl IHost for Host

Source§

fn run<'life0, 'life1, 'async_trait>( &'life0 self, addr: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn stop<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Auto Trait Implementations§

§

impl !RefUnwindSafe for Host

§

impl !UnwindSafe for Host

§

impl Freeze for Host

§

impl Send for Host

§

impl Sync for Host

§

impl Unpin for Host

§

impl UnsafeUnpin for Host

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> IClaimsCarrier for T
where T: Send,

Source§

fn set_claims(&mut self, _claims: Option<Box<dyn IClaims>>)

Default no-op. Overridden by inherent set_claims on types that carry claims.
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, 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<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