Skip to main content

ServiceHandle

Struct ServiceHandle 

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

Shared handle for spawning, stopping, and inspecting managed services.

Implementations§

Source§

impl ServiceHandle

Source

pub fn new(service: Arc<dyn ManagedService>, context: ServiceContext) -> Self

Creates a new handle around a service and context.

Source

pub fn named( name: impl Into<String>, protocol: Option<Protocol>, service: Arc<dyn ManagedService>, ) -> Self

Creates a handle for a named service.

Source

pub fn context(&self) -> ServiceContext

Returns the shared service context.

Source

pub async fn spawn(&self) -> RuntimeResult<()>

Spawns the service task if it is not already running.

Source

pub async fn stop(&self) -> RuntimeResult<()>

Requests service shutdown and waits for the service task.

Source

pub async fn wait(&self) -> RuntimeResult<()>

Waits for the service task to finish if it was spawned.

Source

pub async fn readiness( &self, max_wait: Duration, ) -> RuntimeResult<ServiceStatus>

Waits until the service reports readiness or the timeout elapses.

Source

pub fn status(&self) -> ServiceStatus

Returns the latest status.

Source

pub async fn snapshot(&self) -> RuntimeResult<ServiceSnapshot>

Returns the latest snapshot.

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, 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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