Struct overclock::core::Service

pub struct Service {
    pub actor_type_id: TypeId,
    pub actor_type_name: &'static str,
    pub status: ServiceStatus,
    pub directory: Option<String>,
    pub up_since: SystemTime,
    pub downtime_ms: u64,
    pub microservices: HashMap<ScopeId, Self>,
    pub inactive: HashMap<String, ScopeId>,
}

An actor’s service metrics

Fields

actor_type_id: TypeId

The actor’s type id, who owns/manages the service

actor_type_name: &'static str

The actor type name, only for debuging or to provide context

status: ServiceStatus

The status of the actor

directory: Option<String>

The directory name of the actor, must be unique within the same spawned level

up_since: SystemTime

The start timestamp, used to calculate uptime

downtime_ms: u64

Accumulated downtime

microservices: HashMap<ScopeId, Self>

Microservices

inactive: HashMap<String, ScopeId>

Highlight any stopped service in microservices;

Implementations

impl Service

pub fn new<A: 'static + Actor<S>, S: SupHandle<A>>(
    directory: Option<String>
) -> Self

Create a new Service

pub fn scopes_iter<'a, Child: 'static>(&'a self) -> ServiceScopesIterator<'a>

Create scopes iterator for a the provided Child type

pub fn actor_type_id(&self) -> TypeId

Return the actor type id

pub fn actor_type_name(&self) -> &'static str

Return actor type name, note: only for debuging

pub fn with_status(self, service_status: ServiceStatus) -> Self

Set the service status

pub fn update_status(&mut self, service_status: ServiceStatus)

Update the service status

pub fn directory(&self) -> &Option<String>

Return the directory name of the actor (if available)

pub fn with_downtime_ms(self, downtime_ms: u64) -> Self

Set the service downtime in milliseconds

pub fn is_type<T: 'static>(&self) -> bool

Check the owner actor’s type of the service

pub fn is_stopping(&self) -> bool

Check if the service is stopping

pub fn is_stopped(&self) -> bool

Check if the service is stopped

pub fn is_running(&self) -> bool

Check if the service is running

pub fn is_idle(&self) -> bool

Check if the service is idle

pub fn is_outage(&self) -> bool

Check if the service status is outage

pub fn is_starting(&self) -> bool

Check if the service is starting

pub fn is_initializing(&self) -> bool

Check if the service is initializing

pub fn is_maintenance(&self) -> bool

Check if the service is in maintenance

pub fn is_degraded(&self) -> bool

Check if the service is degraded

pub fn status(&self) -> &ServiceStatus

Get the service status

pub fn microservices(&self) -> &HashMap<ScopeId, Service>

Return immutable reference to the microservices HashMap

Trait Implementations

impl Clone for Service

fn clone(&self) -> Service

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Service

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

Formats the value using the given formatter.

impl Display for Service

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

Formats the value using the given formatter.

impl Serialize for Service

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl TreeItem for Service

type Child = Service

The type of this item’s child items

fn write_self<W: Write>(&self, f: &mut W, _style: &Style) -> Result<()>

Write the item’s own contents (without children) to f

fn children(&self) -> Cow<'_, [Self::Child]>

Retrieve a list of this item’s children