Struct holochain::conductor::state::ConductorState

pub struct ConductorState { /* private fields */ }

Mutable conductor state, stored in a DB and writable only via Admin interface.

References between structs (cell configs pointing to the agent and DNA to be instantiated) are implemented via string IDs.

Implementations

impl ConductorState

pub fn tag(&self) -> &ConductorStateTag

A unique identifier for this conductor

pub fn installed_apps(&self) -> &InstalledAppMap

Immutable access to the inner collection of all apps

pub fn installed_apps_mut(&mut self) -> &mut InstalledAppMap

👎Deprecated: Bare mutable access isn’t the best idea

Mutable access to the inner collection of all apps

pub fn enabled_apps(
    &self
) -> impl Iterator<Item = (&InstalledAppId, &InstalledApp)> + '_

Iterate over only the “enabled” apps

pub fn disabled_apps(
    &self
) -> impl Iterator<Item = (&InstalledAppId, &InstalledApp)> + '_

Iterate over only the “disabled” apps

pub fn running_apps(
    &self
) -> impl Iterator<Item = (&InstalledAppId, RunningApp)> + '_

Iterate over only the “running” apps

pub fn paused_apps(
    &self
) -> impl Iterator<Item = (&InstalledAppId, StoppedApp)> + '_

Iterate over only the paused apps

pub fn stopped_apps(
    &self
) -> impl Iterator<Item = (&InstalledAppId, StoppedApp)> + '_

Iterate over only the “stopped” apps (paused OR disabled)

pub fn get_app(&self, id: &InstalledAppId) -> ConductorResult<&InstalledApp>

Getter for a single app. Returns error if app missing.

pub fn get_app_mut(
    &mut self,
    id: &InstalledAppId
) -> ConductorResult<&mut InstalledApp>

Getter for a mutable reference to a single app. Returns error if app missing.

pub fn remove_app(
    &mut self,
    id: &InstalledAppId
) -> ConductorResult<InstalledApp>

Getter for a single app. Returns error if app missing.

pub fn add_app(&mut self, app: InstalledAppCommon) -> ConductorResult<StoppedApp>

Add an app in the Deactivated state. Returns an error if an app is already present at the given ID.

pub fn transition_app_status(
    &mut self,
    id: &InstalledAppId,
    transition: AppStatusTransition
) -> ConductorResult<(&InstalledApp, AppStatusFx)>

Update the status of an installed app in-place. Return a reference to the (possibly updated) app. Additionally, if an update occurred, return the previous state. If no update occurred, return None.

pub fn get_app_info(
    &self,
    installed_app_id: &InstalledAppId
) -> Option<InstalledAppInfo>

Retrieve info about an installed App by its InstalledAppId

pub fn interface_by_id(&self, id: &AppInterfaceId) -> Option<AppInterfaceConfig>

Returns the interface configuration with the given ID if present

Trait Implementations

impl Clone for ConductorState

fn clone(&self) -> ConductorState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConductorState

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

Formats the value using the given formatter.

impl Default for ConductorState

fn default() -> ConductorState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ConductorState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ConductorState

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

Serialize this value into the given Serde serializer.

impl TryFrom<&ConductorState> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(t: &ConductorState) -> Result<SerializedBytes, SerializedBytesError>

Performs the conversion.

impl TryFrom<ConductorState> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(t: ConductorState) -> Result<SerializedBytes, SerializedBytesError>

Performs the conversion.

impl TryFrom<SerializedBytes> for ConductorState

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(sb: SerializedBytes) -> Result<ConductorState, SerializedBytesError>

Performs the conversion.