rama::http::dep::core::graceful

Struct ShutdownBuilder

pub struct ShutdownBuilder<T> { /* private fields */ }

Expand description

ShutdownBuilder to build a Shutdown manager.

Implementations§

impl ShutdownBuilder<WithSignal<Default>>

pub fn new() -> ShutdownBuilder<WithSignal<Default>>

Create a new ShutdownBuilder, which by default is ready to build a Shutdown.

pub fn without_signal(self) -> ShutdownBuilder<WithoutSignal>

Create a ShutdownBuilder without a trigger signal, meaning it will act like a WaitGroup.

pub fn with_signal<F>(self, future: F) -> ShutdownBuilder<WithSignal<F>>
where F: Future + Send + 'static,

Create a ShutdownBuilder with a custom Future signal.

impl<S> ShutdownBuilder<WithSignal<S>>

pub fn with_overwrite_fn<F, Fut>( self, f: F, ) -> ShutdownBuilder<WithSignalAndOverwriteFn<S, F>>
where F: FnOnce() -> Fut + Send + 'static, Fut: Future + Send + 'static,

Create a ShutdownBuilder with a function which creates a future that will be awaited on as an alternative to waiting for all jobs to be complete.

pub fn with_delay(self, delay: Duration) -> ShutdownBuilder<WithSignal<S>>

Attach a delay to this ShutdownBuilder which will used as a timeout buffer between the shutdown trigger signal and signalling the jobs to be cancelled.

pub fn maybe_with_delay( self, delay: Option<Duration>, ) -> ShutdownBuilder<WithSignal<S>>

Attach a delay to this ShutdownBuilder which will used as a timeout buffer between the shutdown trigger signal and signalling the jobs to be cancelled.

pub fn set_delay( &mut self, delay: Duration, ) -> &mut ShutdownBuilder<WithSignal<S>>

Attach a delay to this ShutdownBuilder which will used as a timeout buffer between the shutdown trigger signal and signalling the jobs to be cancelled.

impl<S, F> ShutdownBuilder<WithSignalAndOverwriteFn<S, F>>

pub fn with_delay( self, delay: Duration, ) -> ShutdownBuilder<WithSignalAndOverwriteFn<S, F>>

Attach a delay to this ShutdownBuilder which will used as a timeout buffer between the shutdown trigger signal and signalling the jobs to be cancelled.

pub fn maybe_with_delay( self, delay: Option<Duration>, ) -> ShutdownBuilder<WithSignalAndOverwriteFn<S, F>>

Attach a delay to this ShutdownBuilder which will used as a timeout buffer between the shutdown trigger signal and signalling the jobs to be cancelled.

pub fn set_delay( &mut self, delay: Duration, ) -> &mut ShutdownBuilder<WithSignalAndOverwriteFn<S, F>>

Attach a delay to this ShutdownBuilder which will used as a timeout buffer between the shutdown trigger signal and signalling the jobs to be cancelled.

impl ShutdownBuilder<WithoutSignal>

pub fn build(self) -> Shutdown

Build a Shutdown that acts like a WaitGroup.

impl<I> ShutdownBuilder<WithSignal<I>>
where I: IntoFuture,

pub fn build(self) -> Shutdown

Build a Shutdown which will allow a shutdown when the shutdown signal has been triggered AND all jobs are complete.

impl<I, F, Fut> ShutdownBuilder<WithSignalAndOverwriteFn<I, F>>
where I: IntoFuture, F: FnOnce() -> Fut + Send + 'static, Fut: Future + Send + 'static,

pub fn build(self) -> Shutdown

Build a Shutdown which will allow a shutdown when the shutdown signal has been triggered AND either all jobs are complete or the overwrite (force) signal has been triggered instead.

Trait Implementations§

impl<T> Debug for ShutdownBuilder<T>
where T: Debug,

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

Formats the value using the given formatter. Read more

impl Default for ShutdownBuilder<WithSignal<Default>>

fn default() -> ShutdownBuilder<WithSignal<Default>>

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

Auto Trait Implementations§

impl<T> Freeze for ShutdownBuilder<T>
where T: Freeze,

impl<T> RefUnwindSafe for ShutdownBuilder<T>
where T: RefUnwindSafe,

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

impl<T> Sync for ShutdownBuilder<T>
where T: Sync,

impl<T> Unpin for ShutdownBuilder<T>
where T: Unpin,

impl<T> UnwindSafe for ShutdownBuilder<T>
where T: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

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

fn rama_from(value: T) -> U

impl<T, U, CrateMarker> RamaInto<U, CrateMarker> for T
where U: RamaFrom<T, CrateMarker>,

fn rama_into(self) -> U

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

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

fn rama_try_from(value: T) -> Result<U, <U as RamaTryFrom<T>>::Error>

impl<T, U, CrateMarker> RamaTryInto<U, CrateMarker> for T
where U: RamaTryFrom<T, CrateMarker>,

type Error = <U as RamaTryFrom<T, CrateMarker>>::Error

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T, CrateMarker>>::Error>

impl<T> Same for T

type Output = T

Should always be Self

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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

impl<T> ErasedDestructor for T
where T: 'static,