Struct ServiceData

pub struct ServiceData {
    pub name: String,
    pub id: NodeId,
    pub status: ServiceStatus,
    /* private fields */
}

The inner Service data structure. Stored globally in the GraphDataCache. Accessed through the Service trait.

Fields

name: String

id: NodeId

status: ServiceStatus

Implementations

impl ServiceData

pub fn deps(&self) -> &[NodeId]

Gets this service’s dependencies as NodeIds. Use the GraphDataCache to get the particular dependencies.

pub fn status(&self) -> ServiceStatus

Gets this service’s status, owned.

pub fn name(&self) -> &str

Gets this service’s name.

pub fn id(&self) -> NodeId

Gets the ID of this ServiceData’s Service resource.

pub fn registered(&self) -> bool

Returns whether ServiceAppExt::register_service was called for this service’s Service resource.

pub fn spin_up(&mut self, world: &mut World)

Spins the service up, automatically running its initialization and on_up hooks. Will do nothing if the service is already up. See hooks for more details.

pub fn restart(&mut self, world: &mut World)

Forcibly spins the service up, automatically running its initialization and on_up hooks. See hooks for more details.

pub fn spin_down(&mut self, world: &mut World)

Spins the service down, automatically running its deinitialization and on_down hooks. Will do nothing if the service is already down for any reason. See hooks for more details.

pub fn fail(&mut self, world: &mut World, error: ServiceError)

Fails the service with the given error. Will run the deinitialization and on_down hooks. If the deinit hook fails during this process, the service will forcibly shut down.

Trait Implementations

impl Clone for ServiceData

fn clone(&self) -> ServiceData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServiceData

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

Formats the value using the given formatter.

impl Hash for ServiceData

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ServiceData

fn eq(&self, other: &ServiceData) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ServiceData

impl StructuralPartialEq for ServiceData