Crate holochain_conductor_api
source ·Expand description
The API interface into the holochain conductor.
The interface is split into admin and app requests and responses. Each has
an associated enum AdminRequest
and AppRequest
that define and
document available methods.
The admin interface generally manages the conductor itself, such as installing apps, changing coordinators, listing dnas, cells and apps, accessing state and metric information dumps, managing agents, etc.
The app interface is smaller and focussed on interfacing with an app directly. Notably the app interface allows calling zome functions and subscribing to signals from the app.
Re-exports§
pub use config::*;
pub use state_dump::*;
Modules§
Structs§
- Info about an installed app, returned as part of
AppResponse::AppInfo
- Cloned cell that was created from a provisioned cell at runtime.
- Provisioned cell, a cell instantiated from a DNA on app installation.
- Cell whose instantiation has been deferred. Not yet implemented.
- The data provided over an app interface in order to make a zome call
Enums§
- Represents the available conductor functions to call over an admin interface.
- Represents the possible responses to an
AdminRequest
and follows a general convention ofnoun_verb
as opposed to theverb_noun
ofAdminRequest
. - A flat, slightly more API-friendly representation of
AppInfo
- Represents the available conductor functions to call over an app interface and will result in a corresponding
AppResponse
message being sent back over the interface connection. - Represents the possible responses to an
AppRequest
. - Filter for
AdminRequest::ListApps
. - Error type that goes over the websocket wire. This intends to be application developer facing so it should be readable and relevant