srvzio 1.1.1

An helpful crate to implement services
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

//! The key module of this library: a `Service`

/// A `Service` is a _black box_ that does work: it can be started and it can be stopped.
///
/// This trait abstracts away the actions that can be done from the outside to a `Service`.
/// It's up to the specific implementor to make sense of what starting/stopping means.
///
/// Note that every method in this trait is by default implemented as a no-op: this leaves to the
/// actual implementor to decide what is fitting to implement, and what is not.
pub trait Service {

  /// Service name
  fn name(&self) -> &'static str;

  /// Starts the service
  fn start(&mut self);

  /// Awaits that the service is done starting.
  ///
  /// Implement to provide sensible logic to wait for a service to be fully started.
  ///
  /// This is usually used _after_ a call to `start()`.
  fn await_started(&mut self) {
    // By default, nothing to do
  }

  /// Starts the service and waits for it to be done starting.
  ///
  /// A _graceful_ start.
  fn start_and_await(&mut self) {
    self.start();
    self.await_started();
  }

  /// Stops the service
  fn stop(&mut self);

  /// Awaits that the service is done stopping.
  ///
  /// Implement to provide sensible logic to wait for a service to be fully stopped.
  ///
  /// This is usually used _after_ a call to `stop()`.
  fn await_stopped(&mut self) {
    // By default, nothing to do
  }

  /// Stops the service and waits for it to be done stopping.
  ///
  /// A _graceful_ stop.
  fn stop_and_await(&mut self) {
    self.stop();
    self.await_stopped();
  }

}