Struct Instance 

pub struct Instance<'a> { /* private fields */ }

Handle to an SMF instance.

Instances may be obtained by way of their parent service (Service::instance()), by direct-FMRI lookup (Scf::instance_from_fmri()), or by direct-FMRI lookup for the current process assuming it is running under SMF (Scf::self_instance_from_env()).

For processes that want to read their own effective configuration, the recommended path is to obtain the self instance via Scf::self_instance_from_env() and then obtain the running snapshot via Instance::snapshot("running").

Implementations

impl Instance<'_>

pub fn smf_state(&mut self) -> Result<String, InstanceSmfStateError>

Get the current SMF state of this instance.

pub fn smf_degrade( &mut self, flags: Option<SmfDegradeFlags>, ) -> Result<(), InstanceOpError>

Put this instance into the degraded state.

Errors

Fails if called under an IsolatedConfigd testing setup.

pub fn smf_disable( &mut self, flags: Option<SmfEnableDisableFlags>, comment: Option<&str>, ) -> Result<(), InstanceOpError>

Put this instance into the disabled state.

Errors

Fails if called under an IsolatedConfigd testing setup.

pub fn smf_enable( &mut self, flags: Option<SmfEnableDisableFlags>, comment: Option<&str>, ) -> Result<(), InstanceOpError>

Put this instance into the enabled state.

Errors

Fails if called under an IsolatedConfigd testing setup.

pub fn smf_maintain( &mut self, flags: Option<SmfMaintainFlags>, ) -> Result<(), InstanceOpError>

Put this instance into the maintenance state.

Errors

Fails if called under an IsolatedConfigd testing setup.

pub fn smf_restart(&mut self) -> Result<(), InstanceOpError>

Restart this instance.

Errors

Fails if called under an IsolatedConfigd testing setup.

pub fn smf_restore(&mut self) -> Result<(), InstanceOpError>

Restore this instance.

Errors

Fails if called under an IsolatedConfigd testing setup.

impl<'a> Instance<'a>

pub fn name(&self) -> &str

The name of this instance.

pub fn fmri(&self) -> &str

The full FMRI of this instance.

pub fn smf_refresh(&mut self) -> Result<(), InstanceOpError>

Refresh this instance.

This is equivalent to running svcadm refresh THIS_INSTANCE; i.e., it will both update the "running" snapshot to match any property changes made since the last time the instance was refreshed and will invoke the instance’s SMF refresh method.

pub fn snapshot(&self, name: &str) -> Result<Option<Snapshot<'_>>, LookupError>

Look up a snapshot in this instance by name.

pub fn snapshots(&self) -> Result<Snapshots<'_>, IterError>

Get an iterator over all Snapshots in this instance.

Trait Implementations

impl<'a> Debug for Instance<'a>

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

Formats the value using the given formatter.

impl EditPropertyGroups for Instance<'_>

fn add_property_group( &mut self, name: &str, pg_type: PropertyGroupType, flags: AddPropertyGroupFlags, ) -> Result<PropertyGroup<'_, PropertyGroupDirect>, PropertyGroupAddError>

Add a new property group.

fn ensure_property_group( &mut self, name: &str, pg_type: PropertyGroupType, flags: AddPropertyGroupFlags, ) -> Result<PropertyGroup<'_, PropertyGroupDirect>, PropertyGroupAddError>

Ensure a property group exists.

fn delete_property_group( &mut self, name: &str, ) -> Result<DeletePropertyGroupResult, PropertyGroupDeleteError>

Delete a property group by name.

impl HasComposedPropertyGroups for Instance<'_>

fn property_group_composed( &self, name: &str, ) -> Result<Option<PropertyGroup<'_, PropertyGroupComposed>>, LookupError>

Look up a composed property group by name.

fn property_groups_composed( &self, ) -> Result<PropertyGroups<'_, PropertyGroupComposed>, IterError>

Iterate over all composed property groups.

impl HasDirectPropertyGroups for Instance<'_>

fn property_group_direct( &self, name: &str, ) -> Result<Option<PropertyGroup<'_, PropertyGroupDirect>>, LookupError>

Look up a direct-attached property group by name.

fn property_groups_direct( &self, ) -> Result<PropertyGroups<'_, PropertyGroupDirect>, IterError>

Iterate over all direct-attached property groups.

impl ToEntityDescription for Instance<'_>

fn to_entity_description(&self) -> ScfEntityDescription

Get the description of this entity.