Module holochain_types::app

Everything to do with App (hApp) installation and uninstallation

An App is a essentially a collection of Cells which are intended to be available for a particular Holochain use-case, such as a microservice used by some UI in a broader application.

Each Cell maintains its own identity separate from any App. Access to Cells can be shared between different Apps.

Modules

• app_manifest_validated
  Normalized, validated representation of the App Manifest.
• error

Structs

• AppBundle
  A bundle of an AppManifest and collection of DNAs
• AppManifestCurrent
  Version 1 of the App manifest schema
• AppManifestCurrentBuilder
  Builder for AppManifestV1.
• AppManifestV1
  Version 1 of the App manifest schema
• AppManifestV1Builder
  Builder for AppManifestV1.
• AppManifestValidated
  Normalized, validated representation of the App Manifest.
• AppRoleAssignment
  App “roles” correspond to cell entries in the AppManifest.
• AppRoleDnaManifest
  The DNA portion of an app role
• AppRoleManifest
  Description of an app “role” defined by this app. Roles get filled according to the provisioning rules, as well as by potential runtime clones.
• AppRoleResolution
  The answer to the question: “how do we concretely assign DNAs to the open roles of this App?” Includes the DNAs selected to fill the roles and the details of the role assignments.
• CreateCloneCellPayload
  The arguments to create a clone of an existing cell.
• DisableCloneCellPayload
  Arguments to specify the clone cell to be disabled.
• InstallAppDnaPayload
  Information needed to specify a DNA as part of an App
• InstallAppPayload
  An AppBundle along with an AgentPubKey and optional InstalledAppId
• InstalledApp
  An app which has been installed. An installed app is merely its collection of “roles”, associated with an ID.
• InstalledAppCommon
  The common data between apps of any status
• InstalledCell
  Data about an installed Cell.
• NetworkInfoRequestPayload
  The instructions on how to request NetworkInfo
• RegisterDnaPayload
  The instructions on how to get the DNA to be registered
• RunningApp
  An active app
• StoppedApp
  An app which is either Paused or Disabled, i.e. not Running
• UpdateCoordinatorsPayload
  The instructions on how to update coordinators for a dna file.

Enums

• AppBundleError
  Errors occurring while installing an AppBundle
• AppBundleSource
  The possible locations of an AppBundle
• AppManifest
  Container struct which uses the manifest_version field to determine which manifest version to deserialize to.
• AppManifestError
• AppRoleManifestValidated
  Rules to determine if and how a Cell will be created for this Dna
• AppStatus
  The status of an installed app.
• AppStatusFx
  A declaration of the side effects of a particular AppStatusTransition.
• AppStatusKind
  The AppStatus without the reasons.
• AppStatusTransition
  Represents a state transition operation from one state to another
• CellProvisioning
  Rules to determine if and how a Cell will be created for this Dna
• CellProvisioningConflict
  Uninhabitable placeholder
• CellProvisioningOp
  Specifies what step should be taken to provision a cell while installing an App
• CloneCellId
  Ways of specifying a clone cell.
• CoordinatorSource
  The source of coordinators to be installed, either as binary data, or from a path
• DisabledAppReason
  The reason for an app being in a Disabled state.
• DnaSource
  The source of the DNA to be installed, either as binary data, or from a path
• PausedAppReason
  The reason for an app being in a Paused state. NB: there is no way to manually pause an app.
• StoppedAppReason
  The various reasons for why an App is not in the Running state.

Functions

• we_must_remember_to_rework_cell_panic_handling_after_implementing_use_existing_cell_resolution
  This function is called in places where it will be necessary to rework that area after use_existing has been implemented

Type Aliases

• DeleteCloneCellPayload
  Arguments to delete a disabled clone cell of an app.
• DnaLocation
  Specifies remote, local, or bundled location of DNA
• EnableCloneCellPayload
  Arguments to specify the clone cell to be enabled.
• InstalledAppId
  The unique identifier for an installed app in this conductor
• InstalledAppMap
  A map from InstalledAppId -> InstalledApp