Skip to main content

ServiceGroup

Struct ServiceGroup 

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

A group of async services that start together and stop together.

Services are started concurrently. Like go-zero’s service group, startup order must not be relied on. When a process shutdown signal, explicit handle stop, or service error occurs, the group broadcasts a shutdown token, runs stop hooks, waits for tasks and returns aggregated errors if any.

Implementations§

Source§

impl ServiceGroup

Source

pub fn new() -> Self

Creates an empty service group with default controls.

Source

pub fn with_config(config: ServiceGroupConfig) -> Self

Creates an empty service group with custom controls.

Source

pub fn add<S>(&mut self, service: S) -> &mut Self
where S: Service,

Adds a service to the group.

Source

pub fn add_arc<S>(&mut self, service: Arc<S>) -> &mut Self
where S: Service,

Adds an already shared service to the group.

Source

pub fn add_fn<F, Fut>(&mut self, name: impl Into<String>, start: F) -> &mut Self
where F: Fn(ShutdownToken) -> Fut + Send + Sync + 'static, Fut: Future<Output = CoreResult<()>> + Send + 'static,

Adds a service backed by an async start function.

Source

pub fn handle(&self) -> ServiceGroupHandle

Returns a handle that can stop the group while it is running.

Source

pub async fn start(self) -> CoreResult<()>

Starts all services and waits for Ctrl-C or explicit stop.

Source

pub async fn start_with_shutdown<F>(self, shutdown: F) -> CoreResult<()>
where F: Future<Output = ()> + Send,

Starts all services and waits for the supplied shutdown future.

Trait Implementations§

Source§

impl Default for ServiceGroup

Source§

fn default() -> Self

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

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

Source§

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
Source§

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
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> 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<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