Struct holochain_types::app::InstalledAppCommon

pub struct InstalledAppCommon { /* private fields */ }

The common data between apps of any status

Implementations

impl InstalledAppCommon

pub fn new<S: ToString, I: IntoIterator<Item = (RoleName, AppRoleAssignment)>>(
    installed_app_id: S,
    _agent_key: AgentPubKey,
    role_assignments: I
) -> AppResult<Self>

Constructor

pub fn id(&self) -> &InstalledAppId

Accessor

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

Accessor

Examples found in repository

src/app.rs (line 500)

    pub fn all_cells(&self) -> impl Iterator<Item = &CellId> {
        self.provisioned_cells()
            .map(|(_, c)| c)
            .chain(self.clone_cell_ids())
            .chain(self.disabled_clone_cell_ids())
    }

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

Accessor

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

Accessor

Examples found in repository

src/app.rs (line 490)

    pub fn clone_cell_ids(&self) -> impl Iterator<Item = &CellId> {
        self.clone_cells().map(|(_, cell_id)| cell_id)
    }

    /// Accessor
    pub fn disabled_clone_cell_ids(&self) -> impl Iterator<Item = &CellId> {
        self.disabled_clone_cells().map(|(_, cell_id)| cell_id)
    }

    /// Iterator of all cells, both provisioned and cloned
    pub fn all_cells(&self) -> impl Iterator<Item = &CellId> {
        self.provisioned_cells()
            .map(|(_, c)| c)
            .chain(self.clone_cell_ids())
            .chain(self.disabled_clone_cell_ids())
    }

    /// Iterator of all "required" cells, meaning Cells which must be running
    /// for this App to be able to run. The notion of "required cells" is not
    /// yet solidified, so for now this placeholder equates to "all cells".
    pub fn required_cells(&self) -> impl Iterator<Item = &CellId> {
        self.all_cells()
    }

    /// Accessor for particular role
    pub fn role(&self, role_name: &RoleName) -> AppResult<&AppRoleAssignment> {
        self.role_assignments
            .get(role_name)
            .ok_or_else(|| AppError::RoleNameMissing(role_name.clone()))
    }

    fn role_mut(&mut self, role_name: &RoleName) -> AppResult<&mut AppRoleAssignment> {
        self.role_assignments
            .get_mut(role_name)
            .ok_or_else(|| AppError::RoleNameMissing(role_name.clone()))
    }

    /// Accessor
    pub fn roles(&self) -> &HashMap<RoleName, AppRoleAssignment> {
        &self.role_assignments
    }

    /// Add a clone cell.
    pub fn add_clone(&mut self, role_name: &RoleName, cell_id: &CellId) -> AppResult<CloneId> {
        let app_role_assignment = self.role_mut(role_name)?;
        assert_eq!(
            cell_id.agent_pubkey(),
            app_role_assignment.agent_key(),
            "A clone cell must use the same agent key as the role it is added to"
        );
        if app_role_assignment.is_clone_limit_reached() {
            return Err(AppError::CloneLimitExceeded(
                app_role_assignment.clone_limit,
                app_role_assignment.clone(),
            ));
        }
        let clone_id = CloneId::new(role_name, app_role_assignment.next_clone_index);
        if app_role_assignment.clones.contains_key(&clone_id) {
            return Err(AppError::DuplicateCloneIds(clone_id));
        }

        // add clone
        app_role_assignment
            .clones
            .insert(clone_id.clone(), cell_id.clone());
        // increment next clone index
        app_role_assignment.next_clone_index += 1;
        Ok(clone_id)
    }

    /// Get a clone cell id from its clone id.
    pub fn get_clone_cell_id(&self, clone_cell_id: &CloneCellId) -> AppResult<CellId> {
        let cell_id = match clone_cell_id {
            CloneCellId::CellId(cell_id) => cell_id,
            CloneCellId::CloneId(clone_id) => self
                .role(&clone_id.as_base_role_name())?
                .clones
                .get(clone_id)
                .ok_or_else(|| {
                    AppError::CloneCellNotFound(CloneCellId::CloneId(clone_id.clone()))
                })?,
        };
        Ok(cell_id.clone())
    }

    /// Get the clone id from either clone or cell id.
    pub fn get_clone_id(&self, clone_cell_id: &CloneCellId) -> AppResult<CloneId> {
        let clone_id = match clone_cell_id {
            CloneCellId::CloneId(id) => id,
            CloneCellId::CellId(id) => {
                self.clone_cells()
                    .find(|(_, cell_id)| *cell_id == id)
                    .ok_or_else(|| AppError::CloneCellNotFound(CloneCellId::CellId(id.clone())))?
                    .0
            }
        };
        Ok(clone_id.clone())
    }

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

Accessor

Examples found in repository

src/app.rs (line 495)

    pub fn disabled_clone_cell_ids(&self) -> impl Iterator<Item = &CellId> {
        self.disabled_clone_cells().map(|(_, cell_id)| cell_id)
    }

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

Examples found in repository

src/app.rs (line 502)

    pub fn all_cells(&self) -> impl Iterator<Item = &CellId> {
        self.provisioned_cells()
            .map(|(_, c)| c)
            .chain(self.clone_cell_ids())
            .chain(self.disabled_clone_cell_ids())
    }

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

Accessor

Examples found in repository

src/app.rs (line 503)

    pub fn all_cells(&self) -> impl Iterator<Item = &CellId> {
        self.provisioned_cells()
            .map(|(_, c)| c)
            .chain(self.clone_cell_ids())
            .chain(self.disabled_clone_cell_ids())
    }

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

Iterator of all cells, both provisioned and cloned

Examples found in repository

src/app.rs (line 510)

    pub fn required_cells(&self) -> impl Iterator<Item = &CellId> {
        self.all_cells()
    }

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. The notion of “required cells” is not yet solidified, so for now this placeholder equates to “all cells”.

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

Accessor for particular role

Examples found in repository

src/app.rs (line 564)

    pub fn get_clone_cell_id(&self, clone_cell_id: &CloneCellId) -> AppResult<CellId> {
        let cell_id = match clone_cell_id {
            CloneCellId::CellId(cell_id) => cell_id,
            CloneCellId::CloneId(clone_id) => self
                .role(&clone_id.as_base_role_name())?
                .clones
                .get(clone_id)
                .ok_or_else(|| {
                    AppError::CloneCellNotFound(CloneCellId::CloneId(clone_id.clone()))
                })?,
        };
        Ok(cell_id.clone())
    }

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, and it is not accessible any longer.

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

Transformer Enable a disabled clone cell.

The clone cell is added back to the list of clones and can be accessed again.

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 new_legacy<S: ToString, I: IntoIterator<Item = InstalledCell>>(
    installed_app_id: S,
    installed_cells: I
) -> AppResult<Self>

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

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::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) -> Self

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::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for InstalledAppCommon

impl StructuralEq for InstalledAppCommon

impl StructuralPartialEq for InstalledAppCommon