Struct holochain_types::app::InstalledApp

pub struct InstalledApp {
    pub status: AppStatus,
    /* private fields */
}

An app which has been installed. An installed app is merely its collection of “roles”, associated with an ID.

Fields

status: AppStatus

The status of the installed app

Implementations

impl InstalledApp

pub fn new(app: InstalledAppCommon, status: AppStatus) -> InstalledApp

impl InstalledApp

pub fn new_fresh(app: InstalledAppCommon) -> Self

Constructor for freshly installed app

pub fn new_running(app: InstalledAppCommon) -> Self

Constructor for freshly installed app

pub fn into_app_and_status(self) -> (InstalledAppCommon, AppStatus)

Return the common app info, as well as a status which encodes the remaining information

pub fn status(&self) -> &AppStatus

Accessor

pub fn id(&self) -> &InstalledAppId

Accessor

Methods from Deref<Target = InstalledAppCommon>

pub fn id(&self) -> &InstalledAppId

Accessor

pub fn provisioned_cells(&self) -> impl Iterator<Item = (&RoleName, &CellId)>

Accessor

pub fn clone_cells(&self) -> impl Iterator<Item = (&CloneId, &CellId)>

Accessor

pub fn disabled_clone_cells(&self) -> impl Iterator<Item = (&CloneId, &CellId)>

Accessor

pub fn clone_cells_for_role_name( &self, role_name: &RoleName ) -> Option<&HashMap<CloneId, CellId>>

Accessor

pub fn disabled_clone_cells_for_role_name( &self, role_name: &RoleName ) -> Option<&HashMap<CloneId, CellId>>

Accessor

pub fn clone_cell_ids(&self) -> impl Iterator<Item = &CellId>

Accessor

pub fn disabled_clone_cell_ids(&self) -> impl Iterator<Item = &CellId>

Accessor

pub fn all_cells(&self) -> impl Iterator<Item = &CellId>

Iterator of all cells, both provisioned and cloned

pub fn all_enabled_cells(&self) -> impl Iterator<Item = &CellId>

Iterator of all running cells, both provisioned and cloned. Provisioned cells will always be running if the app is running, but some cloned cells may be disabled and will not be returned.

pub fn required_cells(&self) -> impl Iterator<Item = &CellId>

Iterator of all “required” cells, meaning Cells which must be running for this App to be able to run.

Currently this is simply all provisioned cells, but this concept may become more nuanced in the future.

pub fn role(&self, role_name: &RoleName) -> AppResult<&AppRoleAssignment>

Accessor for particular role

pub fn roles(&self) -> &HashMap<RoleName, AppRoleAssignment>

Accessor

pub fn add_clone( &mut self, role_name: &RoleName, cell_id: &CellId ) -> AppResult<CloneId>

Add a clone cell.

pub fn get_clone_cell_id( &self, clone_cell_id: &CloneCellId ) -> AppResult<CellId>

Get a clone cell id from its clone id.

pub fn get_clone_id(&self, clone_cell_id: &CloneCellId) -> AppResult<CloneId>

Get the clone id from either clone or cell id.

pub fn get_disabled_clone_id( &self, clone_cell_id: &CloneCellId ) -> AppResult<CloneId>

Get the clone id from either clone or cell id.

pub fn disable_clone_cell(&mut self, clone_id: &CloneId) -> AppResult<()>

Disable a clone cell.

Removes the cell from the list of clones, so it is not accessible any longer. If the cell is already disabled, do nothing and return Ok.

pub fn enable_clone_cell( &mut self, clone_id: &CloneId ) -> AppResult<InstalledCell>

Enable a disabled clone cell.

The clone cell is added back to the list of clones and can be accessed again. If the cell is already enabled, do nothing and return Ok.

Returns

The enabled clone cell.

pub fn delete_clone_cell(&mut self, clone_id: &CloneId) -> AppResult<()>

Delete a disabled clone cell.

pub fn agent_key(&self) -> &AgentPubKey

Accessor

pub fn manifest(&self) -> &AppManifest

Return the manifest if available

pub fn role_assignments(&self) -> &HashMap<RoleName, AppRoleAssignment>

Return the list of role assignments

Trait Implementations

impl AsMut<InstalledAppCommon> for InstalledApp

fn as_mut(&mut self) -> &mut InstalledAppCommon

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<InstalledAppCommon> for InstalledApp

fn as_ref(&self) -> &InstalledAppCommon

Converts this type into a shared reference of the (usually inferred) input type.

impl AutoMapped for InstalledApp

type Key = String

The key type

fn key(&self) -> &Self::Key

Accessor for the key

impl Borrow<InstalledAppCommon> for InstalledApp

fn borrow(&self) -> &InstalledAppCommon

Immutably borrows from an owned value.

impl BorrowMut<InstalledAppCommon> for InstalledApp

fn borrow_mut(&mut self) -> &mut InstalledAppCommon

Mutably borrows from an owned value.

impl Clone for InstalledApp

fn clone(&self) -> InstalledApp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InstalledApp

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

Formats the value using the given formatter.

impl Deref for InstalledApp

type Target = InstalledAppCommon

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for InstalledApp

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for InstalledApp

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<RunningApp> for InstalledApp

fn from(app: RunningApp) -> Self

Converts to this type from the input type.

impl From<StoppedApp> for InstalledApp

fn from(d: StoppedApp) -> Self

Converts to this type from the input type.

impl PartialEq for InstalledApp

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for InstalledApp

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for InstalledApp

impl StructuralPartialEq for InstalledApp