Skip to main content

Shutdown

Struct Shutdown 

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

A cloneable handle used to request and observe server shutdown.

Every clone refers to the same underlying signal. The server stops accepting connections once it is triggered, background tasks receive it, and long-lived handlers (WebSockets, streaming responses) should watch it to finish cleanly:

use kerniq_runtime::Shutdown;

let shutdown = Shutdown::new();
let watcher = shutdown.clone();
let task = tokio::spawn(async move {
    watcher.wait().await;
    "stopped"
});
shutdown.trigger();
assert_eq!(task.await.unwrap(), "stopped");

Implementations§

Source§

impl Shutdown

Source

pub fn new() -> Self

Creates a new, untriggered handle.

Source

pub fn trigger(&self)

Requests shutdown. Idempotent.

Source

pub fn is_triggered(&self) -> bool

Whether shutdown has been requested.

Source

pub async fn wait(&self)

Completes once shutdown has been requested. Cancel-safe.

Source

pub fn wait_owned(&self) -> impl Future<Output = ()> + Send + 'static

An owned future that completes on shutdown (useful for select! in 'static contexts).

Source

pub fn token(&self) -> &CancellationToken

The underlying Tokio cancellation token, for interoperability.

Trait Implementations§

Source§

impl Clone for Shutdown

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Shutdown

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Shutdown

Source§

fn default() -> Self

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

impl From<CancellationToken> for Shutdown

Source§

fn from(token: CancellationToken) -> Self

Converts to this type from the input type.

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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