Struct holochain::prelude::InstalledAppCommon

pub struct InstalledAppCommon { /* private fields */ }

The common data between apps of any status

Implementations

impl InstalledAppCommon

pub fn new<S, I>( installed_app_id: S, agent_key: HoloHash<Agent>, role_assignments: I, manifest: AppManifest ) -> Result<InstalledAppCommon, AppError>where S: ToString, I: IntoIterator<Item = (String, AppRoleAssignment)>,

Constructor

pub fn id(&self) -> &String

Accessor

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

Accessor

pub fn into_provisioned_cells(self) -> impl Iterator<Item = (String, 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: &String ) -> Option<&HashMap<CloneId, CellId, RandomState>>

Accessor

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

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: &String) -> Result<&AppRoleAssignment, AppError>

Accessor for particular role

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

Accessor

pub fn add_clone( &mut self, role_name: &String, cell_id: &CellId ) -> Result<CloneId, AppError>

Add a clone cell.

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

Get a clone cell id from its clone id.

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

Get the clone id from either clone or cell id.

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

Get the clone id from either clone or cell id.

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

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 ) -> Result<InstalledCell, AppError>

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) -> Result<(), AppError>

Delete a disabled clone cell.

pub fn agent_key(&self) -> &HoloHash<Agent>

Accessor

pub fn new_legacy<S, I>( installed_app_id: S, installed_cells: I ) -> Result<InstalledAppCommon, AppError>where S: ToString, I: IntoIterator<Item = InstalledCell>,

Constructor for apps not using a manifest. Allows for cloning up to 256 times and implies immediate provisioning.

pub fn manifest(&self) -> AppManifest

Return the manifest if available

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 AsMut<InstalledAppCommon> for RunningApp

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

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

impl AsMut<InstalledAppCommon> for StoppedApp

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 AsRef<InstalledAppCommon> for RunningApp

fn as_ref(&self) -> &InstalledAppCommon

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

impl AsRef<InstalledAppCommon> for StoppedApp

fn as_ref(&self) -> &InstalledAppCommon

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

impl Borrow<InstalledAppCommon> for InstalledApp

fn borrow(&self) -> &InstalledAppCommon

Immutably borrows from an owned value.

impl Borrow<InstalledAppCommon> for RunningApp

fn borrow(&self) -> &InstalledAppCommon

Immutably borrows from an owned value.

impl Borrow<InstalledAppCommon> for StoppedApp

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 BorrowMut<InstalledAppCommon> for RunningApp

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

Mutably borrows from an owned value.

impl BorrowMut<InstalledAppCommon> for StoppedApp

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

Mutably borrows from an owned value.

impl Clone for InstalledAppCommon

fn clone(&self) -> InstalledAppCommon

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InstalledAppCommon

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InstalledAppCommon

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

Deserialize this value from the given Serde deserializer.

impl From<InstalledAppCommon> for RunningApp

fn from(original: InstalledAppCommon) -> RunningApp

Converts to this type from the input type.

impl From<StoppedApp> for InstalledAppCommon

fn from(d: StoppedApp) -> InstalledAppCommon

Converts to this type from the input type.

impl PartialEq<InstalledAppCommon> for InstalledAppCommon

fn eq(&self, other: &InstalledAppCommon) -> 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 InstalledAppCommon

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

Serialize this value into the given Serde serializer.

impl Eq for InstalledAppCommon

impl StructuralEq for InstalledAppCommon

impl StructuralPartialEq for InstalledAppCommon